Skip to content

Commit 45fe0f5

Browse files
committed
change dockerhub docs references
1 parent 1c47de7 commit 45fe0f5

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

algo-docker.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ usage() {
1111
retcode="${1:-0}"
1212
echo "To run algo from Docker:"
1313
echo ""
14-
echo "docker run --cap-drop=all -it -v <path to configurations>:"${DATA_DIR}" trailofbits/algo:latest"
14+
echo "docker run --cap-drop=all -it -v <path to configurations>:"${DATA_DIR}" ghcr.io/trailofbits/algo:latest"
1515
echo ""
1616
exit ${retcode}
1717
}

docs/deploy-from-docker.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,36 @@ While it is not possible to run your Algo server from within a Docker container,
1313
2. Create a local directory to hold your VPN configs (e.g. `C:\Users\trailofbits\Documents\VPNs\`)
1414
3. Create a local copy of [config.cfg](https://github.com/trailofbits/algo/blob/master/config.cfg), with required modifications (e.g. `C:\Users\trailofbits\Documents\VPNs\config.cfg`)
1515
4. Run the Docker container, mounting your configurations appropriately (assuming the container is named `trailofbits/algo` with a tag `latest`):
16-
- From Windows:
16+
17+
- From Windows:
18+
1719
```powershell
1820
C:\Users\trailofbits> docker run --cap-drop=all -it \
1921
-v C:\Users\trailofbits\Documents\VPNs:/data \
20-
trailofbits/algo:latest
22+
ghcr.io/trailofbits/algo:latest
2123
```
22-
- From Linux:
24+
25+
- From Linux:
26+
2327
```bash
2428
$ docker run --cap-drop=all -it \
2529
-v /home/trailofbits/Documents/VPNs:/data \
26-
trailofbits/algo:latest
30+
ghcr.io/trailofbits/algo:latest
2731
```
32+
2833
5. When it exits, you'll be left with a fully populated `configs` directory, containing all appropriate configuration data for your clients, and for future server management
2934

3035
### Providing Additional Files
36+
3137
If you need to provide additional files -- like authorization files for Google Cloud Project -- you can simply specify an additional `-v` parameter, and provide the appropriate path when prompted by `algo`.
3238

3339
For example, you can specify `-v C:\Users\trailofbits\Documents\VPNs\gce_auth.json:/algo/gce_auth.json`, making the local path to your credentials JSON file `/algo/gce_auth.json`.
3440

3541
### Scripted deployment
42+
3643
Ansible variables (see [Deployment from Ansible](deploy-from-ansible.md)) can be passed via `ALGO_ARGS` environment variable.
3744
_The leading `-e` (or `--extra-vars`) is required_, e.g.
45+
3846
```bash
3947
$ ALGO_ARGS="-e
4048
provider=digitalocean
@@ -50,19 +58,20 @@ $ ALGO_ARGS="-e
5058
$ docker run --cap-drop=all -it \
5159
-e "ALGO_ARGS=$ALGO_ARGS" \
5260
-v /home/trailofbits/Documents/VPNs:/data \
53-
trailofbits/algo:latest
61+
ghcr.io/trailofbits/algo:latest
5462
```
5563

5664
## Managing an Algo Server with Docker
5765

5866
Even though the container itself is transient, because you've persisted the configuration data, you can use the same Docker image to manage your Algo server. This is done by setting the environment variable `ALGO_ARGS`.
5967

6068
If you want to use Algo to update the users on an existing server, specify `-e "ALGO_ARGS=update-users"` in your `docker run` command:
69+
6170
```powershell
6271
$ docker run --cap-drop=all -it \
6372
-e "ALGO_ARGS=update-users" \
6473
-v C:\Users\trailofbits\Documents\VPNs:/data \
65-
trailofbits/algo:latest
74+
ghcr.io/trailofbits/algo:latest
6675
```
6776

6877
## GNU Makefile for Docker

0 commit comments

Comments
 (0)