Archives/algo
2
0
Fork 0
mirror of https://github.com/trailofbits/algo synced 2024-11-18 09:25:38 +00:00
Code Issues Projects Releases Wiki Activity
ca898d5bf2
algo/docs/index.md

33 lines
1.6 KiB
Markdown
Raw Normal View History

Reorganize documentation for GitHub pages (#378) Reorganize documentation for clarity and use with GitHub pages static site generator. This closes #371.
2017-04-13 00:25:31 +00:00
# Algo VPN documentation
Update docs (#1430) * Point additional docs to index.md * Update index.md Moves existing links from readme.md over to update this separate (previously out-of-date, redundant) page. * Update documented Ansible roles * Fix broken links in index.md * Complete index.md As a general rule all docs should be linked to from the index file. No? * Update SSH access instructions * Clarify SSH access instructions * Delete setup-roles.md * Update deploy-from-ansible.md Change header, insert text from setup-roles.md * Remove link to setup-roles from index.md * Fix typos * Update deploy-from-ansible.md Document other `--skip-tags` options, as well as examples for Vultr and Scaleway variables. * Update deploy-from-ansible.md Added region examples for AWS and Lightsail. Happy to add other examples if people have experience with other providers.
2019-05-16 19:01:01 +00:00
* Deployment instructions
The docs got out of sync with the scripts (#480) * The docs got out of sync with the scripts * restructure * fix links
2017-04-23 20:36:30 +00:00
- Deploy from [RedHat/CentOS 6.x](deploy-from-redhat-centos6.md)
- Deploy from [Windows](deploy-from-windows.md)
Update docs (#1430) * Point additional docs to index.md * Update index.md Moves existing links from readme.md over to update this separate (previously out-of-date, redundant) page. * Update documented Ansible roles * Fix broken links in index.md * Complete index.md As a general rule all docs should be linked to from the index file. No? * Update SSH access instructions * Clarify SSH access instructions * Delete setup-roles.md * Update deploy-from-ansible.md Change header, insert text from setup-roles.md * Remove link to setup-roles from index.md * Fix typos * Update deploy-from-ansible.md Document other `--skip-tags` options, as well as examples for Vultr and Scaleway variables. * Update deploy-from-ansible.md Added region examples for AWS and Lightsail. Happy to add other examples if people have experience with other providers.
2019-05-16 19:01:01 +00:00
- Deploy from a [Docker container](deploy-from-docker.md)
- Deploy from [Ansible](deploy-from-ansible.md) non-interactively
Documentation updates (#1607) * update variable name to store_pki * Document BetweenClients_DROP * Update README.md * Update faq.md * VPN On Demand is for Apple IPSEC clients only * How to update users from cloud-init * How to monitor user activity * Fix typo * Update FAQ about WireGuard, fix typos * Correct locations of install log and user configs * Update-users from cloud-init * Update features list * More "IPsec" and "WireGuard" changes * fixed broken link/absent link in FAQ * Python version README fix for #1622 * road warrior instructions * Update index.md * Reorganize config.cfg As per @davidemyers suggestions * Further config changes As per feedback, also better explanation of keys_clean_all * Add road warrior instructions to FAQ * Remove specific ports from RW instructions
2019-12-10 18:23:18 +00:00
- Deploy onto a [cloud server at time of creation with shell script or cloud-init](deploy-from-script-or-cloud-init-to-localhost.md)
Add deploy-from-macos.md (#1649)
2019-12-08 12:12:24 +00:00
- Deploy from [macOS](deploy-from-macos.md)
Document using Google Cloud Shell (#1699)
2020-01-22 10:39:36 +00:00
- Deploy from [Google Cloud Shell](deploy-from-cloudshell.md)
Reorganize documentation for GitHub pages (#378) Reorganize documentation for clarity and use with GitHub pages static site generator. This closes #371.
2017-04-13 00:25:31 +00:00
* Client setup
Better documentation (#459) * Closes #443 * Remove numbers * context * split up local and scripted * Closes #458 * . * better layout * Closes #451 * do this later * grammar * typo
2017-04-20 21:56:03 +00:00
- Setup [Android](client-android.md) clients
typo
2017-04-20 22:28:16 +00:00
- Setup [Generic/Linux](client-linux.md) clients with Ansible
Update docs (#1430) * Point additional docs to index.md * Update index.md Moves existing links from readme.md over to update this separate (previously out-of-date, redundant) page. * Update documented Ansible roles * Fix broken links in index.md * Complete index.md As a general rule all docs should be linked to from the index file. No? * Update SSH access instructions * Clarify SSH access instructions * Delete setup-roles.md * Update deploy-from-ansible.md Change header, insert text from setup-roles.md * Remove link to setup-roles from index.md * Fix typos * Update deploy-from-ansible.md Document other `--skip-tags` options, as well as examples for Vultr and Scaleway variables. * Update deploy-from-ansible.md Added region examples for AWS and Lightsail. Happy to add other examples if people have experience with other providers.
2019-05-16 19:01:01 +00:00
- Setup Ubuntu clients to use [WireGuard](client-linux-wireguard.md)
Documentation updates (#1607) * update variable name to store_pki * Document BetweenClients_DROP * Update README.md * Update faq.md * VPN On Demand is for Apple IPSEC clients only * How to update users from cloud-init * How to monitor user activity * Fix typo * Update FAQ about WireGuard, fix typos * Correct locations of install log and user configs * Update-users from cloud-init * Update features list * More "IPsec" and "WireGuard" changes * fixed broken link/absent link in FAQ * Python version README fix for #1622 * road warrior instructions * Update index.md * Reorganize config.cfg As per @davidemyers suggestions * Further config changes As per feedback, also better explanation of keys_clean_all * Add road warrior instructions to FAQ * Remove specific ports from RW instructions
2019-12-10 18:23:18 +00:00
- 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)
Update docs (#1430) * Point additional docs to index.md * Update index.md Moves existing links from readme.md over to update this separate (previously out-of-date, redundant) page. * Update documented Ansible roles * Fix broken links in index.md * Complete index.md As a general rule all docs should be linked to from the index file. No? * Update SSH access instructions * Clarify SSH access instructions * Delete setup-roles.md * Update deploy-from-ansible.md Change header, insert text from setup-roles.md * Remove link to setup-roles from index.md * Fix typos * Update deploy-from-ansible.md Document other `--skip-tags` options, as well as examples for Vultr and Scaleway variables. * Update deploy-from-ansible.md Added region examples for AWS and Lightsail. Happy to add other examples if people have experience with other providers.
2019-05-16 19:01:01 +00:00
* Cloud provider setup
- Configure [Amazon EC2](cloud-amazon-ec2.md)
Better documentation (#459) * Closes #443 * Remove numbers * context * split up local and scripted * Closes #458 * . * better layout * Closes #451 * do this later * grammar * typo
2017-04-20 21:56:03 +00:00
- Configure [Azure](cloud-azure.md)
adds DigitalOcean documentation (#869)
2018-04-23 22:58:40 +00:00
- Configure [DigitalOcean](cloud-do.md)
Update docs (#1430) * Point additional docs to index.md * Update index.md Moves existing links from readme.md over to update this separate (previously out-of-date, redundant) page. * Update documented Ansible roles * Fix broken links in index.md * Complete index.md As a general rule all docs should be linked to from the index file. No? * Update SSH access instructions * Clarify SSH access instructions * Delete setup-roles.md * Update deploy-from-ansible.md Change header, insert text from setup-roles.md * Remove link to setup-roles from index.md * Fix typos * Update deploy-from-ansible.md Document other `--skip-tags` options, as well as examples for Vultr and Scaleway variables. * Update deploy-from-ansible.md Added region examples for AWS and Lightsail. Happy to add other examples if people have experience with other providers.
2019-05-16 19:01:01 +00:00
- Configure [Google Cloud Platform](cloud-gce.md)
Large refactor to support Ansible 2.5 (#976) * Refactoring, booleans declaration and update users fix * Make server_name more FQDN compatible * Rename variables * Define the default value for store_cakey * Skip a prompt about the SSH user if deploying to localhost * Disable reboot for non-cloud deployments * Enable EC2 volume encryption by default * Add default server value (localhost) for the local installation Delete empty files * Add default region to aws_region_facts * Update docs * EC2 credentials fix * Warnings fix * Update deploy-from-ansible.md * Fix a typo * Remove lightsail from the docs * Disable EC2 encryption by default * rename droplet to server * Disable dependencies * Disable tls_cipher_suite * Convert wifi-exclude to a string. Update-users fix * SSH access congrats fix * 16.04 > 18.04 * Dont ask for the credentials if specified in the environment vars * GCE server name fix
2018-08-27 14:05:45 +00:00
- Configure [Vultr](cloud-vultr.md)
New cloud provider CloudStack (#1420) * clean commits from branch cloud-cloudstack w/ proper committer email/name * fixed ansible-lint errors * corrected typo in prompted message * standalone cloudstack zones module * added missing environment variables * remove `_cloudstack_zones` default variable * Move to Ubuntu 19.04 * Update cloud-cloudstack.md * Update cloud-cloudstack.md Markdown doesn't render `<your account>` * Update prompts.yml * Update main.yml
2019-08-15 13:23:10 +00:00
- Configure [CloudStack](cloud-cloudstack.md)
Refactor to support Ansible 2.8 (#1549) * bump ansible to 2.8.3 * DigitalOcean: move to the latest modules * Add Hetzner Cloud * Scaleway and Lightsail fixes * lint missing roles * Update roles/cloud-hetzner/tasks/main.yml Add api_token Co-Authored-By: phaer <phaer@phaer.org> * Update roles/cloud-hetzner/tasks/main.yml Add api_token Co-Authored-By: phaer <phaer@phaer.org> * Try to run apt until succeeded * Scaleway modules upgrade * GCP: Refactoring, remove deprecated modules * Doc updates (#1552) * Update README.md Adding links and mentions of Exoscale aka CloudStack and Hetzner Cloud. * Update index.md Add the Hetzner Cloud to the docs index * Remove link to Win 10 IPsec instructions * Delete client-windows.md Unnecessary since the deprecation of IPsec for Win10. * Update deploy-from-ansible.md Added sections and required variables for CloudStack and Hetzner Cloud. * Update deploy-from-ansible.md Added sections for CloudStack and Hetzner, added req variables and examples, mentioned environment variables, and added links to the provider role section. * Update deploy-from-ansible.md Cosmetic changes to links, fix typo. * Update GCE variables * Update deploy-from-script-or-cloud-init-to-localhost.md Fix a finer point, and make variables list more readable. * update azure requirements * Python3 draft * set LANG=c to the p12 password generation task * Update README * Install cloud requirements to the existing venv * FreeBSD fix * env->.env fixes * lightsail_region_facts fix * yaml syntax fix * Update README for Python 3 (#1564) * Update README for Python 3 * Remove tabs and tweak instructions * Remove cosmetic command indentation * Update README.md * Update README for Python 3 (#1565) * DO fix for "found unpermitted parameters: id" * Verify Python version * Remove ubuntu 16.04 from readme * Revert back DigitalOcean module * Update deploy-from-script-or-cloud-init-to-localhost.md * env to .env
2019-09-28 00:10:20 +00:00
- Configure [Hetzner Cloud](cloud-hetzner.md)
Better documentation (#459) * Closes #443 * Remove numbers * context * split up local and scripted * Closes #458 * . * better layout * Closes #451 * do this later * grammar * typo
2017-04-20 21:56:03 +00:00
* Advanced Deployment
Doc improvements (#479) * cleanup * typos * Closes #289 Add instructions for connecting to the VPN and configuring on demand.
2017-04-23 18:54:54 +00:00
- Deploy to your own [FreeBSD](deploy-to-freebsd.md) server
Documentation updates (#1607) * update variable name to store_pki * Document BetweenClients_DROP * Update README.md * Update faq.md * VPN On Demand is for Apple IPSEC clients only * How to update users from cloud-init * How to monitor user activity * Fix typo * Update FAQ about WireGuard, fix typos * Correct locations of install log and user configs * Update-users from cloud-init * Update features list * More "IPsec" and "WireGuard" changes * fixed broken link/absent link in FAQ * Python version README fix for #1622 * road warrior instructions * Update index.md * Reorganize config.cfg As per @davidemyers suggestions * Further config changes As per feedback, also better explanation of keys_clean_all * Add road warrior instructions to FAQ * Remove specific ports from RW instructions
2019-12-10 18:23:18 +00:00
- Deploy to your own [Ubuntu](deploy-to-ubuntu.md) server, and road warrior setup
The docs got out of sync with the scripts (#480) * The docs got out of sync with the scripts * restructure * fix links
2017-04-23 20:36:30 +00:00
- Deploy to an [unsupported cloud provider](deploy-to-unsupported-cloud.md)
Reorganize documentation for GitHub pages (#378) Reorganize documentation for clarity and use with GitHub pages static site generator. This closes #371.
2017-04-13 00:25:31 +00:00
* [FAQ](faq.md)
Update docs (#1430) * Point additional docs to index.md * Update index.md Moves existing links from readme.md over to update this separate (previously out-of-date, redundant) page. * Update documented Ansible roles * Fix broken links in index.md * Complete index.md As a general rule all docs should be linked to from the index file. No? * Update SSH access instructions * Clarify SSH access instructions * Delete setup-roles.md * Update deploy-from-ansible.md Change header, insert text from setup-roles.md * Remove link to setup-roles from index.md * Fix typos * Update deploy-from-ansible.md Document other `--skip-tags` options, as well as examples for Vultr and Scaleway variables. * Update deploy-from-ansible.md Added region examples for AWS and Lightsail. Happy to add other examples if people have experience with other providers.
2019-05-16 19:01:01 +00:00
* [Firewalls](firewalls.md)
Better documentation (#459) * Closes #443 * Remove numbers * context * split up local and scripted * Closes #458 * . * better layout * Closes #451 * do this later * grammar * typo
2017-04-20 21:56:03 +00:00
* [Troubleshooting](troubleshooting.md)
Reference in New Issue Copy Permalink