From 94d870e3259c681e17ba0c1f6b9f8dd6cdda4d36 Mon Sep 17 00:00:00 2001 From: Jurgen Verhasselt Date: Mon, 30 Oct 2017 18:41:48 +0100 Subject: [PATCH] docs/client-linux.md housekeeping --- docs/client-linux.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/client-linux.md b/docs/client-linux.md index 89e17e58..a5fd5b4b 100644 --- a/docs/client-linux.md +++ b/docs/client-linux.md @@ -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`. \ No newline at end of file