Update README.md

This commit is contained in:
David Stephens 2018-08-09 22:08:24 +01:00 committed by GitHub
parent 77d62deb76
commit 37f6723efe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -53,15 +53,16 @@ Ansible NAS should work on any recent Ubuntu box. Development was done on Ubuntu
## How To Use ## How To Use
1. Enable the Ubuntu Universe repository: `sudo add-apt-repository universe`
1. `git clone https://www.github.com/davestephens/ansible-nas && cd ansible-nas` 2. Install Ansible: `sudo apt install ansible`
2. Copy `group_vars/all.yml.dist` to `group_vars/all.yml`. 3. `git clone https://github.com/davestephens/ansible-nas.git && cd ansible-nas`
3. Open up `group_vars/all.yml` and follow the instructions there for configuring your Ansible NAS. 4. Copy `group_vars/all.yml.dist` to `group_vars/all.yml`.
3. If you plan to use Transmission with OpenVPN, also copy `group_vars/vpn_credentials.yml.dist` to 5. Open up `group_vars/all.yml` and follow the instructions there for configuring your Ansible NAS.
6. If you plan to use Transmission with OpenVPN, also copy `group_vars/vpn_credentials.yml.dist` to
`group_vars/vpn_credentials.yml` and fill in your settings. `group_vars/vpn_credentials.yml` and fill in your settings.
4. Modify `inventory` and update it with the hostname of your NAS box. 7. Modify `inventory` and update it with the hostname of your NAS box, or use `localhost ansible_connection=local` if you want to run the playbook on the same box you want to use as your ansible-nas.
5. Install the dependent roles: `sudo ansible-galaxy install -r requirements.yml` 8. Install the dependent roles: `sudo ansible-galaxy install -r requirements.yml`
5. Run the playbook - something like `ansible-playbook -i inventory nas.yml -b -K` should do you nicely. 9. Run the playbook - something like `ansible-playbook -i inventory nas.yml -b -K` should do you nicely.
## Migrating from FreeNAS ## Migrating from FreeNAS