Skip to content

Commit b7a4483

Browse files
TC1977jackivanov
authored andcommitted
Update cloud-vultr.md (trailofbits#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
1 parent 1e35753 commit b7a4483

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ After this process completes, the Algo VPN server will contain only the users li
204204
- Configure [Azure](docs/cloud-azure.md)
205205
- Configure [DigitalOcean](docs/cloud-do.md)
206206
- Configure [Google Cloud Platform](docs/cloud-gce.md)
207+
- Configure [Vultr](docs/cloud-vultr.md)
207208
* Advanced Deployment
208209
- Deploy to your own [FreeBSD](docs/deploy-to-freebsd.md) server
209210
- Deploy to your own [Ubuntu 18.04](docs/deploy-to-ubuntu.md) server

docs/cloud-vultr.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
### Configuration file
22

3-
You need to create a configuration file in INI format with your api key (https://my.vultr.com/settings/#settingsapi)
3+
Algo requires an API key from your Vultr account in order to create a server. The API key is generated by going to your Vultr settings at https://my.vultr.com/settings/#settingsapi, and then selecting "generate new API key" on the right side of the box labeled "API Key".
4+
5+
Algo can read the API key in several different ways. Algo will first look for the file containing the API key in the environment variable $VULTR_API_CONFIG if present. You can set this with the command: `export VULTR_API_CONFIG=/path/to/vultr.ini`. Probably the simplest way to give Algo the API key is to create a file titled `.vultr.ini` in your home directory by typing `nano ~/.vultr.ini`, then entering the following text:
46

57
```
68
[default]
79
key = <your api key>
810
```
11+
where you've cut-and-pasted the API key from above into the `<your api key>` field (no brackets).
12+
13+
When Algo asks `Enter the local path to your configuration INI file
14+
(https://trailofbits.github.io/algo/cloud-vultr.html):` if you hit enter without typing anything, Algo will look for the file in `~/.vultr.ini` by default.
15+

0 commit comments

Comments
 (0)