diff --git a/README.md b/README.md index a32c88f..ec77d93 100644 --- a/README.md +++ b/README.md @@ -190,11 +190,42 @@ _If you chose to save the CA key during the deploy process,_ then Algo's own scr After this process completes, the Algo VPN server will contain only the users listed in the `config.cfg` file. ## Additional Documentation -* [Deployment instructions, cloud provider setup instructions, and further client setup instructions available here.](docs/index.md) * [FAQ](docs/faq.md) * [Troubleshooting](docs/troubleshooting.md) +* How Algo uses [Firewalls](docs/firewalls.md) -If you read all the documentation and have further questions, [join the chat on Gitter](https://gitter.im/trailofbits/algo). +### Setup Instructions for Specific Cloud Providers +* Configure [Amazon EC2](docs/cloud-amazon-ec2.md) +* Configure [Azure](docs/cloud-azure.md) +* Configure [DigitalOcean](docs/cloud-do.md) +* Configure [Google Cloud Platform](docs/cloud-gce.md) +* Configure [Vultr](docs/cloud-vultr.md) +* Configure [CloudStack](docs/cloud-cloudstack.md) +* Configure [Hetzner Cloud](docs/cloud-hetzner.md) + +### Install and Deploy from Common Platforms +* Deploy from [macOS](docs/deploy-from-macos.md) +* Deploy from [Windows](docs/deploy-from-windows.md) +* Deploy from [Google Cloud Shell](docs/deploy-from-cloudshell.md) +* Deploy from [RedHat/CentOS 6.x](docs/deploy-from-redhat-centos6.md) +* Deploy from a [Docker container](docs/deploy-from-docker.md) + +### Setup VPN Clients to Connect to the Server +* Setup [Android](docs/client-android.md) clients +* Setup [Linux](docs/client-linux.md) clients with Ansible +* Setup Ubuntu clients to use [WireGuard](docs/client-linux-wireguard.md) +* Setup Linux clients to use [IPsec](docs/client-linux-ipsec.md) +* Setup Apple devices to use [IPsec](docs/client-apple-ipsec.md) +* Setup Macs running macOS 10.13 or older to use [WireGuard](docs/client-macos-wireguard.md) + +### Advanced Deployment +* Deploy to your own [Ubuntu](docs/deploy-to-ubuntu.md) server, and road warrior setup +* Deploy from [Ansible](docs/deploy-from-ansible.md) non-interactively +* 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) +* Deploy to an [unsupported cloud provider](docs/deploy-to-unsupported-cloud.md) +* Deploy to your own [FreeBSD](docs/deploy-to-freebsd.md) server + +If you've read all the documentation and have further questions, [join the chat on Gitter](https://gitter.im/trailofbits/algo). ## Endorsements diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 8b6ac8f..0000000 --- a/docs/index.md +++ /dev/null @@ -1,32 +0,0 @@ -# Algo VPN documentation - -* Deployment instructions - - Deploy from [RedHat/CentOS 6.x](deploy-from-redhat-centos6.md) - - Deploy from [Windows](deploy-from-windows.md) - - Deploy from a [Docker container](deploy-from-docker.md) - - Deploy from [Ansible](deploy-from-ansible.md) non-interactively - - Deploy onto a [cloud server at time of creation with shell script or cloud-init](deploy-from-script-or-cloud-init-to-localhost.md) - - Deploy from [macOS](deploy-from-macos.md) - - Deploy from [Google Cloud Shell](deploy-from-cloudshell.md) -* Client setup - - Setup [Android](client-android.md) clients - - Setup [Generic/Linux](client-linux.md) clients with Ansible - - Setup Ubuntu clients to use [WireGuard](client-linux-wireguard.md) - - Setup Linux clients to use [IPsec](client-linux-ipsec.md) - - Setup Apple devices to use [IPsec](client-apple-ipsec.md) - - Setup Macs running macOS 10.13 or older to use [WireGuard](client-macos-wireguard.md) -* Cloud provider setup - - Configure [Amazon EC2](cloud-amazon-ec2.md) - - Configure [Azure](cloud-azure.md) - - Configure [DigitalOcean](cloud-do.md) - - Configure [Google Cloud Platform](cloud-gce.md) - - Configure [Vultr](cloud-vultr.md) - - Configure [CloudStack](cloud-cloudstack.md) - - Configure [Hetzner Cloud](cloud-hetzner.md) -* Advanced Deployment - - Deploy to your own [FreeBSD](deploy-to-freebsd.md) server - - Deploy to your own [Ubuntu](deploy-to-ubuntu.md) server, and road warrior setup - - Deploy to an [unsupported cloud provider](deploy-to-unsupported-cloud.md) -* [FAQ](faq.md) -* [Firewalls](firewalls.md) -* [Troubleshooting](troubleshooting.md)