Skip to content

Commit f76d361

Browse files
authored
Move document index into README (#1815)
Move the list of available documentation into the main README.
1 parent 5efa20b commit f76d361

File tree

2 files changed

+34
-35
lines changed

2 files changed

+34
-35
lines changed

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,11 +190,42 @@ _If you chose to save the CA key during the deploy process,_ then Algo's own scr
190190
After this process completes, the Algo VPN server will contain only the users listed in the `config.cfg` file.
191191
192192
## Additional Documentation
193-
* [Deployment instructions, cloud provider setup instructions, and further client setup instructions available here.](docs/index.md)
194193
* [FAQ](docs/faq.md)
195194
* [Troubleshooting](docs/troubleshooting.md)
196-
197-
If you read all the documentation and have further questions, [join the chat on Gitter](https://gitter.im/trailofbits/algo).
195+
* How Algo uses [Firewalls](docs/firewalls.md)
196+
197+
### Setup Instructions for Specific Cloud Providers
198+
* Configure [Amazon EC2](docs/cloud-amazon-ec2.md)
199+
* Configure [Azure](docs/cloud-azure.md)
200+
* Configure [DigitalOcean](docs/cloud-do.md)
201+
* Configure [Google Cloud Platform](docs/cloud-gce.md)
202+
* Configure [Vultr](docs/cloud-vultr.md)
203+
* Configure [CloudStack](docs/cloud-cloudstack.md)
204+
* Configure [Hetzner Cloud](docs/cloud-hetzner.md)
205+
206+
### Install and Deploy from Common Platforms
207+
* Deploy from [macOS](docs/deploy-from-macos.md)
208+
* Deploy from [Windows](docs/deploy-from-windows.md)
209+
* Deploy from [Google Cloud Shell](docs/deploy-from-cloudshell.md)
210+
* Deploy from [RedHat/CentOS 6.x](docs/deploy-from-redhat-centos6.md)
211+
* Deploy from a [Docker container](docs/deploy-from-docker.md)
212+
213+
### Setup VPN Clients to Connect to the Server
214+
* Setup [Android](docs/client-android.md) clients
215+
* Setup [Linux](docs/client-linux.md) clients with Ansible
216+
* Setup Ubuntu clients to use [WireGuard](docs/client-linux-wireguard.md)
217+
* Setup Linux clients to use [IPsec](docs/client-linux-ipsec.md)
218+
* Setup Apple devices to use [IPsec](docs/client-apple-ipsec.md)
219+
* Setup Macs running macOS 10.13 or older to use [WireGuard](docs/client-macos-wireguard.md)
220+
221+
### Advanced Deployment
222+
* Deploy to your own [Ubuntu](docs/deploy-to-ubuntu.md) server, and road warrior setup
223+
* Deploy from [Ansible](docs/deploy-from-ansible.md) non-interactively
224+
* Deploy onto a [cloud server at time of creation with shell script or cloud-init](docs/deploy-from-script-or-cloud-init-to-localhost.md)
225+
* Deploy to an [unsupported cloud provider](docs/deploy-to-unsupported-cloud.md)
226+
* Deploy to your own [FreeBSD](docs/deploy-to-freebsd.md) server
227+
228+
If you've read all the documentation and have further questions, [join the chat on Gitter](https://gitter.im/trailofbits/algo).
198229

199230
## Endorsements
200231

docs/index.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)