Mirrors/ansible-nas
2
0
Fork 0
mirror of https://github.com/davestephens/ansible-nas synced 2024-12-25 02:53:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Installation docs in one place only

Browse source
This commit is contained in:
David Stephens 2020-01-07 22:23:21 +00:00
parent 59a6a5e57c
commit be254a4424
2 changed files with 22 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -96,37 +96,9 @@ Ansible NAS doesn't set up your disk partitions, primarily because getting it wr
That aside, configuring partitions is usually a one-time (or very infrequent) event, so there's not much to be
gained by automating it. Check out the [docs](https://davestephens.github.io/ansible-nas) for recommended setups.
## Quick Start
## Installation
:skull: Before running anything, check out the playbook and understand what it
does. Run it against a VM and make sure you're happy. ***Do not*** blindly
download code from the internet and trust that it's going to work as you expect.
:skull:
1. Enable the Ubuntu Universe repository:
`sudo add-apt-repository universe`
2. Install Ansible:
`sudo apt install ansible`
3. Clone Ansible-NAS:
`git clone https://github.com/davestephens/ansible-nas.git && cd ansible-nas`
4. Create your own inventory and config files by copying `inventories/sample` to your own directory:
`cp -rfp inventories/sample inventories/my-ansible-nas`
5. Review `group_vars/all.yml`. Change settings by overriding them in `inventories/my-ansible-nas/group_vars/all.yml`.
6. Update `inventories/my-ansible-nas/inventory`.
7. Install the dependent roles: `ansible-galaxy install -r requirements.yml` (you might need `sudo` to install Ansible roles).
8. Run the playbook - something like `ansible-playbook -i inventories/my-ansible-nas/inventory nas.yml -b -K` should do you nicely.
See [Installation](https://davestephens.github.io/ansible-nas/installation/).
## Upgrading

34
docs/installation.md
View file

@ -1,24 +1,30 @@
:skull: :skull: :skull: Before running anything, check out the playbook and understand what it
does. Run it against a VM and make sure you're happy. ***Do not*** blindly
download code from the internet and trust that it's going to work as you expect.
:skull: :skull: :skull:
You can run Ansible-NAS from the computer you plan to use for your NAS, or from a remote controlling machine. The steps for deployment are exactly the same, just pay attention to editing the inventory file in step 7.
1. Enable the Ubuntu Universe repository: `sudo add-apt-repository universe`
1. Enable the Ubuntu Universe repository:
1. Install Ansible: `sudo apt install ansible`
`sudo add-apt-repository universe`
1. `git clone https://github.com/davestephens/ansible-nas.git && cd ansible-nas`
2. Install Ansible:
1. Copy `group_vars/all.yml.dist` to `group_vars/all.yml`.
`sudo apt install ansible`
1. Open up `group_vars/all.yml` and follow the instructions there for
configuring your Ansible NAS.
3. Clone Ansible-NAS:
1. 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.
`git clone https://github.com/davestephens/ansible-nas.git && cd ansible-nas`
1. Copy `inventory.dist` to `inventory` and update it.
4. Create your own inventory and config files by copying `inventories/sample` to your own directory:
1. Install the dependent roles: `ansible-galaxy install -r requirements.yml`
(you might need sudo to install Ansible roles)
`cp -rfp inventories/sample inventories/my-ansible-nas`
1. Run the playbook - something like `ansible-playbook -i inventory nas.yml -b
-K` should do you nicely.
5. Review `group_vars/all.yml`. Change settings by overriding them in `inventories/my-ansible-nas/group_vars/all.yml`.
6. Update `inventories/my-ansible-nas/inventory`.
7. Install the dependent roles: `ansible-galaxy install -r requirements.yml` (you might need `sudo` to install Ansible roles).
8. Run the playbook - something like `ansible-playbook -i inventories/my-ansible-nas/inventory nas.yml -b -K` should do you nicely.