mirror of
https://github.com/trailofbits/algo
synced 2024-11-13 19:12:06 +00:00
70 lines
4.7 KiB
Markdown
70 lines
4.7 KiB
Markdown
# Docker Support
|
|
|
|
While it is not possible to run your Algo server from within a Docker container, it is possible to use Docker to provision your Algo server.
|
|
|
|
## Limitations
|
|
|
|
1. [Advanced](deploy-from-ansible.md) installations are not currently supported; you must use the interactive `algo` script.
|
|
2. This has not yet been tested with user namespacing enabled.
|
|
3. If you're running this on Windows, take care when editing files under `configs/` to ensure that line endings are set appropriately for Unix systems.
|
|
|
|
## Deploying an Algo Server with Docker
|
|
|
|
1. Install [Docker](https://www.docker.com/community-edition#/download) -- setup and configuration is not covered here
|
|
2. Create a local directory to hold your VPN configs (e.g. `C:\Users\trailofbits\Documents\VPNs\`)
|
|
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`)
|
|
4. Run the Docker container, mounting your configurations appropriately (assuming the container is named `trailofbits/algo` with a tag `latest`):
|
|
- From Windows:
|
|
```powershell
|
|
C:\Users\trailofbits> docker run --cap-drop=all -it \
|
|
-v C:\Users\trailofbits\Documents\VPNs:/data \
|
|
trailofbits/algo:latest
|
|
```
|
|
- From Linux:
|
|
```bash
|
|
$ docker run --cap-drop=all -it \
|
|
-v /home/trailofbits/Documents/VPNs:/data \
|
|
trailofbits/algo:latest
|
|
```
|
|
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
|
|
|
|
### Providing Additional Files
|
|
f
|
|
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`.
|
|
|
|
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`.
|
|
|
|
## Managing an Algo Server with Docker
|
|
|
|
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`.
|
|
|
|
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:
|
|
```powershell
|
|
$ docker run --cap-drop=all -it \
|
|
-e "ALGO_ARGS=update-users" \
|
|
-v C:\Users\trailofbits\Documents\VPNs:/data \
|
|
trailofbits/algo:latest
|
|
```
|
|
|
|
## Building Your Own Docker Image
|
|
|
|
You can use the Dockerfile provided in this repository as-is, or modify it to suit your needs. Further instructions on building an image can be found in the [Docker engine](https://docs.docker.com/engine/) documents.
|
|
|
|
## Security Considerations
|
|
|
|
Using Docker is largely no different from running Algo yourself, with a couple of notable exceptions: we run as root within the container, and you're retrieving your content from Docker Hub.
|
|
|
|
To work around the limitations of bind mounts in docker, we have to run as root within the container. To mitigate concerns around doing this, we pass the `--cap-drop=all` parameter to `docker run`, which effectively removes all privileges from the root account, reducing it to a generic user account that happens to have a userid of 0. Further steps can be taken by applying `seccomp` profiles to the container; this is being considered as a future improvement.
|
|
|
|
Docker themselves provide a concept of [Content Trust](https://docs.docker.com/engine/security/trust/content_trust/) for image management, which helps to ensure that the image you download is, in fact, the image that was uploaded. Content trust is still under development, and while we may be using it, its implementation, limitations, and constraints are documented with Docker.
|
|
|
|
## Future Improvements
|
|
|
|
1. Even though we're taking care to drop all capabilities to minimize the impact of running as root, we can probably include not only a `seccomp` profile, but also AppArmor and/or SELinux profiles as well.
|
|
2. The Docker image doesn't natively support [advanced](deploy-from-ansible.md) Algo deployments, which is useful for scripting. This can be done by launching an interactive shell and running the commands yourself.
|
|
3. The way configuration is passed into and out of the container is a bit kludgy. Hopefully future improvements in Docker volumes will make this a bit easier to handle.
|
|
|
|
## Advanced Usage
|
|
|
|
If you want to poke around the Docker container yourself, you can do so by changing your `entrypoint`. Pass `--entrypoint=/bin/ash` as a parameter to `docker run`, and you'll be dropped into a full Linux shell in the container.
|