Skip to content

Commit d72f3b5

Browse files
davidemyersjackivanov
authored andcommitted
Update Windows documentation (#1640)
* Update Windows documentation * Revise instructions
1 parent 9f27c25 commit d72f3b5

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

docs/deploy-from-windows.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1-
# Windows client prerequisite
1+
# Deploy from Windows
22

3+
The Algo scripts can't be run directly on Windows, but you can use the Windows Subsystem for Linux (WSL) to run a copy of Ubuntu Linux right on your Windows system.
4+
5+
To run WSL you will need:
6+
7+
* A 64-bit system
38
* 64-bit Windows 10 (Anniversary update or later version)
49

5-
Once you verify your system is 64-bit (32-bit is not supported) and up to date, you have to do a few manual steps to enable the 'Windows Subsystem for Linux':
10+
## Install WSL
11+
12+
Enable the 'Windows Subsystem for Linux':
613

714
1. Open 'Settings'
815
2. Click 'Update & Security', then click the 'For developers' option on the left.
@@ -17,17 +24,25 @@ Wait a minute for Windows to install a few things in the background (it will eve
1724
5. Restart Windows and then [install Ubuntu from the Windows Store](https://www.microsoft.com/p/ubuntu/9nblggh4msv6).
1825
6. Run Ubuntu from the Start menu. It will take a few minutes to install. It will have you create a separate user account for the Linux subsystem. Once that's done, you will finally have Ubuntu running somewhat integrated with Windows.
1926

27+
## Install Algo
2028

21-
Install additional packages:
29+
Run these commands in the Ubuntu Terminal to install a prerequisite package and download the Algo scripts to your home directory. Note that when using WSL you should **not** install Algo in the `/mnt/c` directory due to problems with file permissions.
30+
31+
You may need to follow [these directions](https://devblogs.microsoft.com/commandline/copy-and-paste-arrives-for-linuxwsl-consoles/) in order to paste commands into the Ubuntu Terminal.
2232

2333
```shell
24-
sudo apt-get update && sudo apt-get install git build-essential libssl-dev libffi-dev python3-dev python3-pip python3-setuptools python3-virtualenv -y
34+
cd
35+
umask 0002
36+
sudo apt update
37+
sudo apt install -y python3-virtualenv
38+
git clone https://github.com/trailofbits/algo
39+
cd algo
2540
```
2641

27-
Clone the Algo repository:
42+
Now you can continue by following the [README](https://github.com/trailofbits/algo#deploy-the-algo-server) from the 4th step to deploy your Algo server!
2843

44+
You'll be instructed to edit the file `config.cfg` in order to specify the Algo user accounts to be created. If you're new to Linux the simplest editor to use is `nano`. To edit the file while in the `algo` directory, run:
2945
```shell
30-
cd ~ && git clone https://github.com/trailofbits/algo && cd algo
46+
nano config.cfg
3147
```
32-
33-
Now, you can go through the [README](https://github.com/trailofbits/algo#deploy-the-algo-server) (start from the 4th step) and deploy your Algo server!
48+
Once `./algo` has finished you can use the `cp` command to copy the configuration files from the `configs` directory into your Windows directory under `/mnt/c/Users` for easier access.

0 commit comments

Comments
 (0)