Skip to content

Commit

Permalink
README: Add more details to instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin1 committed Apr 13, 2017
1 parent a09f4a1 commit b71103a
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
# Algo VPN Driver Scripts
# Algo VPN Driver Script

Some driver scripts for [Algo][algo-gh]. How to use:
Some driver scripts for [Algo][algo-gh]. Although Algo's installation process is
already very easy to use, I wanted something that didn't require user
interaction.

1. In `config.cfg` put your name under `users`.
2. Paste the entire script into your provider's cloud-init box when creating
## Features

- Installs Algo's dependencies.
- Installs other useful tools, such as `htop`.
- Finds parameters to pass into Algo, such as the IP address.

## Usage

1. Paste the entire script into your provider's cloud-init box when creating
your VPS.
2. If you want to use the SSH tunnel, make sure the provider will write keys to
`/root/.ssh/authorized_keys`.
3. Log into the server and wait for a .mobileconfig file to appear in
`/root/algo/configs/`.

If you're just experimenting, you can launch a free DigitalOcean instance for 2
hours using [dply.co](https://dply.co/).
Expand Down

0 comments on commit b71103a

Please sign in to comment.