wallenstein/algo
1
0
Fork 0
mirror of https://github.com/trailofbits/algo.git synced 2025-08-14 08:43:01 +02:00
Code Issues Projects Releases Wiki Activity

docs: Add sudo requirement for local installations (#14790)

Browse source 
This addresses the issue reported in PR #14173 where local installations
fail with 'sudo: a password is required' error. The sudo requirement is
now properly documented in the local installation guide rather than the
main README.

When installing Algo locally (on the same system where the scripts are
installed), administrative privileges are required to configure system
services and network settings.
This commit is contained in:
Dan Guido 2025-08-03 07:04:17 -04:00 • committed by GitHub
parent 640249ae59
commit 49aa9c49a4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/deploy-to-ubuntu.md
View file

@ -16,6 +16,12 @@ Install to existing Ubuntu latest LTS server (for more advanced users)
Make sure your target server is running an unmodified copy of the operating system version specified. The target can be the same system where you've installed the Algo scripts, or a remote system that you are able to access as root via SSH without needing to enter the SSH key passphrase (such as when using `ssh-agent`).
**Note:** If you're installing locally (when the target is the same system where you've installed the Algo scripts), you'll need to run the deployment command with sudo:
```
sudo ./algo
```
This is required because the installation process needs administrative privileges to configure system services and network settings.
## Inbound VPN Server (also called "Road Warrior" setup)
Some may find it useful to set up an Algo server on an Ubuntu box on your home LAN, with the intention of being able to securely access your LAN and any resources on it when you're traveling elsewhere (the ["road warrior" setup](https://en.wikipedia.org/wiki/Road_warrior_(computing))). A few tips if you're doing so: