Commit Graph

216 Commits

Author SHA1 Message Date
David Myers
f76d361c55
Move document index into README (#1815)
Move the list of available documentation into the main README.
2020-07-22 15:54:06 -04:00
Eugene Pirogov
3f86ae0713
Few cosmetic change to readme (#1813)
Several small improvements around markup for code blocks
2020-05-30 15:57:34 +03:00
Dan Hughes
512b5660e1
Use user-defined hostname for SSH hostname (#1715)
* Use user-defined hostname for SSH hostname

* Update readme to use hostname in ssh commands
2020-02-12 08:14:13 +01:00
Dan Hughes
5c09d6dd02
Use absolute path for identityfile in ssh config (#1718)
* Use absolute path for identityfile in ssh config

* Update readme with ssh config include
2020-02-12 07:58:20 +01:00
David Myers
6ac2e2d1a4 Document using Google Cloud Shell (#1699) 2020-01-22 11:39:36 +01:00
David Myers
2d94bbd278 Documentation updates (#1694) 2020-01-21 12:09:09 +01:00
Jack Ivanov
0629aa5ca5
Update badge 2020-01-13 17:26:05 +01:00
Jack Ivanov
cc72728c6d
Update badge 2020-01-13 17:23:42 +01:00
Jack Ivanov
d635c76b50
Change default SSH port and introduce cloud-init support (#1636)
* Change default SSH port

* Iptables to ansible_ssh_port

* Add Scaleway

* permissions and groups fixes

* update firewall docs

* SSH fixes

* add missing cloudinit to cloud-azure

* remove ansible_ssh_user from the tests

* congrats message fix
2020-01-07 14:28:19 +01:00
TC1977
45aa0065cd 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 19:23:18 +01:00
David Myers
d18de4b679 Add deploy-from-macos.md (#1649) 2019-12-08 13:12:24 +01:00
Jack Ivanov
88eaf30e65
Update README.md (#1602)
* Update README.md

As noted in #1599 we don't have any instructions for CentOS 7. Closes #1599

* Update README.md

Co-Authored-By: David Myers <dem@myersnet.net>
2019-10-09 08:34:06 +02:00
Jack Ivanov
8bdd99c05d 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 08:10:20 +08:00
Jack Ivanov
38d8a6d0e2 Deprecate IKEv2 for Windows (#1521)
* Windows to WireGuard

* Add note about WireGuard

* change wireguard faq

* Clarify Windows instructions

* Correct Wireguard description

* Update README.md
2019-07-31 11:28:33 -04:00
David Myers
902fdab3a0 Update local install instructions (#1527) 2019-07-22 11:28:23 +02:00
TC1977
baa6efc666 Clarify: CA key must be saved to be able to update users (#1460)
* Update README.md

* certificate -> key
2019-06-06 09:45:42 +02:00
Jack Ivanov
a2fdc509e1
Support for Ubuntu 19.04 (#1405)
* Ubuntu 19.04

* Azure to 19.04
2019-05-30 20:57:47 +02:00
David Myers
98f89adeba Add reference to Fedora docs in README (#1456) 2019-05-30 14:07:22 +02:00
TC1977
38ebe4893d 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 21:01:01 +02:00
Rémy Léone
826a2c5036 Add documentation about Scaleway credentials (#1419) 2019-05-12 11:21:55 +02:00
TC1977
b7a448350a Update cloud-vultr.md (#1406)
* Update cloud-vultr.md

More fleshed-out instructions for generating an API key and saving the file. Also notes the default ansible behavior of looking for the file in `~/.vultr.ini`.

* Update README.md
2019-04-26 06:54:37 +02:00
TC1977
505538bcbb Update README.md (#1380)
Add mention of Wireguard SSID exclusion ability.
2019-04-17 11:44:58 -04:00
Dan Guido
db34d55b78
AGPLv3 change (#1351) 2019-03-17 11:19:24 -04:00
Jack Ivanov
273c7665d3 Refactoring (#1334)
<!--- Provide a general summary of your changes in the Title above -->

## Description
Renames the vpn role to strongswan, and split up the variables to support 2 separate VPNs. Closes #1330 and closes #1162
Configures Ansible to use python3 on the server side. Closes #1024 
Removes unneeded playbooks, reorganises a lot of variables
Reorganises the `config` folder. Closes #1330
<details><summary>Here is how the config directory looks like now</summary>
<p>

```
configs/X.X.X.X/
|-- ipsec
|   |-- apple
|   |   |-- desktop.mobileconfig
|   |   |-- laptop.mobileconfig
|   |   `-- phone.mobileconfig
|   |-- manual
|   |   |-- cacert.pem
|   |   |-- desktop.p12
|   |   |-- desktop.ssh.pem
|   |   |-- ipsec_desktop.conf
|   |   |-- ipsec_desktop.secrets
|   |   |-- ipsec_laptop.conf
|   |   |-- ipsec_laptop.secrets
|   |   |-- ipsec_phone.conf
|   |   |-- ipsec_phone.secrets
|   |   |-- laptop.p12
|   |   |-- laptop.ssh.pem
|   |   |-- phone.p12
|   |   `-- phone.ssh.pem
|   `-- windows
|       |-- desktop.ps1
|       |-- laptop.ps1
|       `-- phone.ps1
|-- ssh-tunnel
|   |-- desktop.pem
|   |-- desktop.pub
|   |-- laptop.pem
|   |-- laptop.pub
|   |-- phone.pem
|   |-- phone.pub
|   `-- ssh_config
`-- wireguard
    |-- desktop.conf
    |-- desktop.png
    |-- laptop.conf
    |-- laptop.png
    |-- phone.conf
    `-- phone.png
```

![finder](https://i.imgur.com/FtOmKO0.png)

</p>
</details>

## Motivation and Context
This refactoring is focused to aim to the 1.0 release

## How Has This Been Tested?
Deployed to several cloud providers with various options enabled and disabled

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [x] Refactoring

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [x] I have read the **CONTRIBUTING** document.
- [x] My code follows the code style of this project.
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] All new and existing tests passed.
2019-03-10 13:16:34 -04:00
David Myers
df3d547fb3 Document using WireGuard app on macOS (#1327)
* Document using WireGuard app on macOS

* Update README.md

* Make WireGuard the default for Apple devices

* clarify user list

* fix tests

* connect on demand
2019-02-17 18:38:19 -05:00
Jack Ivanov
b8e1c253c6
Fixes #1305 2019-01-23 07:14:37 +01:00
David Myers
f25415dde3 Document using WireGuard on iOS (#1266) 2019-01-23 07:12:43 +01:00
Jack Ivanov
11ed8b8f30
Update README.md 2019-01-08 08:57:40 +01:00
David Myers
9830947dfd Sync list of supported cloud hosts (#1278) 2019-01-02 19:24:18 -05:00
TC1977
5d74ded90f Update README.md (#1286)
Adds Wireguard to the first line.
2019-01-02 19:23:37 -05:00
Michael Schubert
0177284fea README: fix small typos (#1262) 2018-12-20 09:20:39 -05:00
Jack Ivanov
a66d8f0069 on-build python venvs (#1199) 2018-11-22 13:04:58 -05:00
Aleksander
465cbeb7e0 Update StrongSwan setup docs (#1181) 2018-10-30 07:59:50 +01:00
Bruno Tavares
54a91447bf Add documentation on how to setup GCE accounts (#1164)
* Add documentation on how to setup GCE accounts

This commit adds the steps needed to create a credential with the needed access on Google Cloud Platform to be able to successfully create a new algo VPN.

Related to:
- https://github.com/trailofbits/algo/issues/682
- https://github.com/trailofbits/algo/issues/658

* Adds links on main README to GCP

* Adds link to Ansible documentation

* Update cloud-gce.md
2018-10-28 09:35:43 +03:00
Jack Ivanov
3468d27e61 Lightsail back (#1157) 2018-10-22 16:49:18 -04:00
David Myers
ee3cb979f7 Document how to use WireGuard on Ubuntu clients (#1071) 2018-08-28 17:25:40 +03:00
Jack Ivanov
635e7ff1af
Update README.md 2018-08-27 20:23:51 +03:00
Mike Myers
c65961a1f3 Amazon ec2 documentation (#1035)
* Add link to documentation on Amazon EC2 setup

* Add images to document the AWS EC2 account setup

* Create AWS EC2 setup instructions

* remove line breaks

* remove line breaks

* Add images documenting AWS EC2 policy creation

* Update image showing advised minimum AWS policy

* Add instructions for minimum AWS permission policy

* Delete aws-ec2-attach-policy.png

* Updated image to reflect new AWS policy guidance

* Delete aws-ec2-new-user-confirm.png

* Updated image to reflect new AWS policy guidance
2018-07-22 17:58:09 -04:00
Jack Ivanov
daca84b640 Update references to 18.04 2018-05-30 17:11:32 +03:00
Jack Ivanov
3488e660ad Add WireGuard support for Android (#910)
* WireGuard Implementation

* Update client-android.md

* Update README.md

* WireGuard unattended upgrades

* Update README.md

* reload-module-on-update and syntax fix

* SaveConfig to true

* Azure firewall. Fixes #962

* Update README.md

* Update client-android.md
2018-05-24 08:15:27 -07:00
pguizeline
daf609ea03 Update README.md (#931)
- Adds missing providers to the documentation with links.
- Mentions that your own server install needs to be an Ubuntu 16.04 LTS distro
- Emphasize that the p12 certificate password will only be available once
2018-05-08 13:57:21 -07:00
Steven Crossan
4bd59bebf4 Update DO doc link in README.md (#890) 2018-04-24 19:42:23 -07:00
Cat Jones
e78df40468 adds DigitalOcean documentation (#869) 2018-04-23 15:58:40 -07:00
Micah R Ledbetter
e944ee993a Embed certs into Windows deployment scripts (#840)
- Obviate need to copy separate script and certificate files
- Allow execution from any directory, not just the script's parent
  directory (no assumption of any particular working directory)
- Fix docs that neglected to mention copying cacert.pem
- Fix docs that incorrectly referred to the user cert store

As part of this work, rewrite the windows_client.ps1.j2 deployment
script template

- Add comment-based help
- Require admin privileges
- Use a Param() block
- Use parameter sets with -Add and -Remove switches
- Add the -GetInstalledCerts switch, to list any Algo certificates
  installed the machine's cert store
- Add the -SaveCerts switch, to save the embedded certificates to files
- Put Jinja2 variables inside Powershell variables,
- Use native Powershell cmdlets rather than shell out to certutil.exe
- Add a playbook to regenerate the windows_USER.ps1 scripts
2018-03-28 11:20:43 -07:00
Utkan Gezer
32cbec6f5b Multi-line virtualenv setup script (#829)
Changed the single-line virtualenv setup script into multi-line one. Should be equivalent to what it was before, and now viewable/copy-able without scrolling.
2018-03-27 21:50:50 +03:00
Berry Phillips
ea7da89257 Explicitly create the virtualenv with Python2 (#823) 2018-03-08 22:16:40 -05:00
Jurgen Verhasselt
d08e525906 Docs to deploy from, and setup client on, Fedora Workstation (#711)
* docs/client-linux.md housekeeping

* add fedora-workstation instructions to client-linx.md

* add deploy-from-fedora-workstation doc

* change client-linux.md to internal link

* add deploy-from-fedora-workstation links

* correct markup

* correct typo
2017-11-12 17:10:19 -05:00
Dan Guido
95cb34b8ba Clear up methods of support even more 2017-07-15 02:10:00 -04:00
The Gitter Badger
3032c55b1f Add a Gitter chat badge to README.md (#599)
* Add Gitter badge

* Create README.md
2017-06-10 12:33:30 -04:00
The Gitter Badger
be200b33bf Add a Gitter chat badge to README.md (#598)
* Add Gitter badge

* Update README.md
2017-06-10 12:28:43 -04:00