Skip to content

Commit 23a0583

Browse files
committed
Merge remote-tracking branch 'origin/master' into 196-simple-webapp-config
2 parents 03d18f6 + 3f86ae0 commit 23a0583

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,18 +55,18 @@ The easiest way to get an Algo server running is to run it on your local system
5555

5656
- **Linux:** Recent releases of Ubuntu, Debian, and Fedora come with Python 3 already installed. Make sure your system is up-to-date and install the supporting package(s):
5757
* Ubuntu and Debian:
58-
```bash
59-
sudo apt install -y python3-virtualenv
60-
```
58+
```bash
59+
sudo apt install -y python3-virtualenv
60+
```
6161
* Fedora:
62-
```bash
63-
sudo dnf install -y python3-virtualenv
64-
```
62+
```bash
63+
sudo dnf install -y python3-virtualenv
64+
```
6565
* Red Hat and CentOS 7 and later (for earlier versions see this [documentation](docs/deploy-from-redhat-centos6.md)):
66-
```bash
67-
sudo yum -y install epel-release
68-
sudo yum install -y python36-virtualenv
69-
```
66+
```bash
67+
sudo yum -y install epel-release
68+
sudo yum -y install python36-virtualenv
69+
```
7070

7171
- **Windows:** Use the Windows Subsystem for Linux (WSL) to create your own copy of Ubuntu running under Windows from which to install and run Algo. See the [Windows documentation](docs/deploy-from-windows.md).
7272

@@ -151,19 +151,25 @@ Depending on the platform, you may need one or multiple of the following files.
151151

152152
If you turned on the optional SSH tunneling role, then local user accounts will be created for each user in `config.cfg` and SSH authorized_key files for them will be in the `configs` directory (user.ssh.pem). SSH user accounts do not have shell access, cannot authenticate with a password, and only have limited tunneling options (e.g., `ssh -N` is required). This ensures that SSH users have the least access required to setup a tunnel and can perform no other actions on the Algo server.
153153

154-
Use the example command below to start an SSH tunnel by replacing `<user>` and `<ip>` with your own. Once the tunnel is setup, you can configure a browser or other application to use 127.0.0.1:1080 as a SOCKS proxy to route traffic through the Algo server.
154+
Use the example command below to start an SSH tunnel by replacing `<user>` and `<ip>` with your own. Once the tunnel is setup, you can configure a browser or other application to use 127.0.0.1:1080 as a SOCKS proxy to route traffic through the Algo server:
155155

156-
`ssh -D 127.0.0.1:1080 -f -q -C -N <user>@algo -i configs/<ip>/ssh-tunnel/<user>.pem -F configs/<ip>/ssh_config`
156+
```bash
157+
ssh -D 127.0.0.1:1080 -f -q -C -N <user>@algo -i configs/<ip>/ssh-tunnel/<user>.pem -F configs/<ip>/ssh_config
158+
```
157159

158160
## SSH into Algo Server
159161

160162
Your Algo server is configured for key-only SSH access for administrative purposes. Open the Terminal app, `cd` into the `algo-master` directory where you originally downloaded Algo, and then use the command listed on the success message:
161163

162-
`ssh -F configs/<ip>/ssh_config <hostname>`
164+
```
165+
ssh -F configs/<ip>/ssh_config <hostname>
166+
```
163167

164-
where `<ip>` is the IP address of your Algo server. If you find yourself regularly logging into the server then it will be useful to load your Algo ssh key automatically. Add the following snippet to the bottom of `~/.bash_profile` to add it to your shell environment permanently.
168+
where `<ip>` is the IP address of your Algo server. If you find yourself regularly logging into the server then it will be useful to load your Algo ssh key automatically. Add the following snippet to the bottom of `~/.bash_profile` to add it to your shell environment permanently:
165169

166-
`ssh-add ~/.ssh/algo > /dev/null 2>&1`
170+
```
171+
ssh-add ~/.ssh/algo > /dev/null 2>&1
172+
```
167173

168174
Alternatively, you can choose to include the generated configuration for any Algo servers created into your SSH config. Edit the file `~/.ssh/config` to include this directive at the top:
169175

0 commit comments

Comments
 (0)