docs/client-linux.md housekeeping

This commit is contained in:
Jurgen Verhasselt 2017-10-30 18:41:48 +01:00
parent 6572c2fb34
commit 94d870e325

View file

@ -1,19 +1,22 @@
# Linux client setup
## Provision client config
After you deploy a server, you can use an included Ansible script to provision Linux clients too! Debian, Ubuntu, CentOS, and Fedora are supported. The playbook is `deploy_client.yml`.
### Required variables:
### Required variables
* `client_ip` - The IP address of your client machine (You can use `localhost` in order to deploy locally)
* `vpn_user` - The username. (Ensure that you have valid certificates and keys in the `configs/SERVER_ip/pki/` directory)
* `ssh_user` - The username that we need to use in order to connect to the client machine via SSH (ignore if you are deploying locally)
* `server_ip` - The vpn server ip address
### Example:
### Example
```shell
ansible-playbook deploy_client.yml -e 'client_ip=client.com vpn_user=jack server_ip=vpn-server.com ssh_user=root'
```
### Additional options:
If the user requires sudo password use the following argument: `--ask-become-pass`
### Additional options
If the user requires sudo password use the following argument: `--ask-become-pass`.