| .github | ||
| .vscode | ||
| docs | ||
| files/guacamole | ||
| group_vars | ||
| misc | ||
| tasks | ||
| templates | ||
| tests | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| ansible.cfg | ||
| inventory.dist | ||
| LICENSE | ||
| mkdocs.yml | ||
| nas.yml | ||
| permission_data.yml | ||
| README.md | ||
| requirements.yml | ||
| Vagrantfile | ||
Ansible NAS
After getting burned by broken FreeNAS updates one too many times, I figured I could do a much better job myself using just a stock Ubuntu install, some clever Ansible config and a bunch of Docker containers.
What This Sets Up
- An awesome dashboard to your home server (Heimdall)
- Any number of Samba shares for you to store your stuff
- A BitTorrent client
- Various media management tools - Sonarr, Sickrage, CouchPotato, Radarr
- Media streaming via Plex or Emby
- Music streaming with Airsonic
- An RSS newsfeed reader - Miniflux
- A Dropbox replacement via Nextcloud
- Various ways to see stats about your NAS - Glances, dashboards in Grafana
- A backup tool - allows scheduled backups to Amazon S3, OneDrive, Dropbox etc
- An IRC bouncer
- Source control with Gitea
- SSL secured external access to some applications via Traefik
- A Docker host with Portainer for image and container management
- An automatic dynamic DNS updater if you use Cloudflare to host your domain DNS
Docker Containers Used
- Airsonic - catalog and stream music
- Cloudflare DDNS - automatically update Cloudflare with your dynamic IP address
- CouchPotato - for downloading and managing movies
- Duplicati - for backing up your stuff
- Emby - Media streaming and management
- get_iplayer - download programmes from BBC iplayer
- Gitea - Self-hosted Github clone
- Glances - for seeing the state of your system via a web browser
- Grafana - Dashboarding tool
- Guacamole - Web based remote desktop gateway, supports VNC, RDP and SSH
- Heimdall - Home server dashboard
- InfluxDB - Time series database used for stats collection
- Jackett - API Support for your favorite torrent trackers
- MiniDlna - simple media server which is fully compliant with DLNA/UPnP-AV clients
- Miniflux - An RSS news reader
- MyMediaForAlexa - Lets you stream your music collection to your alexa device
- Netdata - An extremely comprehensive system monitoring solution
- Nextcloud - A self-hosted Dropbox alternative
- Plex - Plex Media Server
- Portainer - for managing Docker and running custom images
- Radarr - for organising and downloading movies
- Sickrage - for managing TV episodes
- Sonarr - for downloading and managing TV episodes
- Tautulli - Monitor Your Plex Media Server
- Telegraf - Metrics collection agent
- TimeMachine - Mac backup server
- Traefik - Web proxy and SSL certificate manager
- Transmission - BitTorrent client (with OpenVPN if you have a supported VPN provider)
- Watchtower - Monitor your Docker containers and update them if a new version is available
- ZNC - IRC bouncer to stay connected to favourite IRC networks and channels
What This Could Do
Ansible-NAS can run anything that's in a Docker image, which is why Portainer is included. A NAS configuration is a pretty personal thing based on what you download, what media you view, how many photos you take...so it's difficult to please everyone.
That said, if specific functionality you want isn't included and you think others could benefit, add it and raise a PR!
What This Doesn't Do
Ansible NAS doesn't set up your disk partitions, primarily because getting it wrong can be incredibly destructive. That aside, configuring partitions is usually a one-time (or very infrequent) event, so there's not much to be gained by automating it.
Quick Start
💀 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. 💀
- Enable the Ubuntu Universe repository:
sudo add-apt-repository universe - Install Ansible:
sudo apt install ansible git clone https://github.com/davestephens/ansible-nas.git && cd ansible-nas- Copy
group_vars/all.yml.disttogroup_vars/all.yml. - Open up
group_vars/all.ymland follow the instructions there for configuring your Ansible NAS. - If you plan to use Transmission with OpenVPN, also copy
group_vars/vpn_credentials.yml.disttogroup_vars/vpn_credentials.ymland fill in your settings. - Copy
inventory.disttoinventoryand update it. - Install the dependent roles:
ansible-galaxy install -r requirements.yml(you might need sudo to install Ansible roles) - Run the playbook - something like
ansible-playbook -i inventory nas.yml -b -Kshould do you nicely.
Documentation
You can read the docs here. PRs for more documentation always welcome!
Migrating from FreeNAS
Assuming that your Ubuntu system disk is separate from your storage (it should be!):
- Ensure you have a working backup of your data.
- Check that the working backup you think you have actually works.
- SSH to the server and run
zpool listto determine available ZFS pools. zpool import <pool_name>against each of the pools you want to attach.chown -R root:root /mnt/<pool_name>to fix the ownership of the data.- Follow the Quick Start instructions above.
Hardware
Ansible NAS should work on any recent Ubuntu box. Development is done on Ubuntu Server 18.04.1 LTS running on an HP Microserver.
Getting Help
Getting help is easy! You can:
Contributing
Contributions are welcome, please feel free to raise a PR!
- Restrict pull requests to one piece of functionality or bugfix at a time.
- Test your new functionality or bugfix using the included
tests/test-vagrant.shscript to spin up a test VM. - Run
ansible-lintagainst the playbook before committing. (There is a VSCode task set up to run the right command for you) - Please know that your efforts are appreciated, thanks! 👍
Development of Ansible-NAS is carried out in Visual Studio Code - you'll get some nice recommended extensions and task setups if you do the same.