Docs inventory reference update

This commit is contained in:
David Stephens 2020-01-25 23:40:26 +00:00
parent 800407e64c
commit d799a1b3dd
31 changed files with 38 additions and 36 deletions

View file

@ -6,7 +6,7 @@ Airsonic is a free, web-based media streamer, providing ubiquitous access to you
## Usage
Set `airsonic_enabled: true` in your `group_vars/all.yml` file.
Set `airsonic_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The Airsonic web interface can be found at http://ansible_nas_host_or_ip:4040.

View file

@ -8,7 +8,7 @@ Bazarr is a companion application to Sonarr and Radarr. It manages and downloads
## Usage
Set `bazarr_enabled: true` in your `group_vars/all.yml` file.
Set `bazarr_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
## Specific Configuration

View file

@ -7,7 +7,7 @@ This is a Bitwarden server API implementation written in Rust compatible with up
## Usage
Set `bitwarden_enabled: true` in your `group_vars/all.yml` file.
Set `bitwarden_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
## Specific Configuration

View file

@ -7,7 +7,7 @@ Calibre-Web is a web app providing a clean interface for browsing, reading and d
## Usage
Set `calibre_enabled: true` in your `group_vars/all.yml` file.
Set `calibre_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
## Specific Configuration

View file

@ -8,10 +8,10 @@ Cloud Commander is a file manager for the web. It includes a command-line consol
## Usage
Set `cloudcmd_enabled: true` in your `group_vars/all.yml` file.
Set `cloudcmd_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
By default your the root of your Ansible-NAS box (`/`) is mounted into `/mnt/fs` within the container. If you'd like to
change this update `cloudcmd_browse_directory` in your `group_vars/all.yml` file.
change this update `cloudcmd_browse_directory` in your `inventories/<your_inventory>/nas.yml` file.
If you enable external access to Cloud Commander (note that this is not recommended) then ensure you configure authorisation
within the application (F10 from the main menu).

View file

@ -8,8 +8,8 @@ host A record to point to your static IP, or enable this container to automatica
## Usage
Set `cloudflare_ddns_enabled: true` in your `group_vars/all.yml` file.
Set `cloudflare_ddns_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
## Specific Configuration
Make sure you set your Cloudflare login, domain and API key details within your `group_vars/all.yml` file.
Make sure you set your Cloudflare login, domain and API key details within your `inventories/<your_inventory>/nas.yml` file.

View file

@ -11,7 +11,7 @@ similar functionality.
## Usage
Set `emby_enabled: true` in your `group_vars/all.yml` file. There are further
Set `emby_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. There are further
parameters you can edit such as `movies_root` and `tv_root` lower down.
## Specific Configuration

View file

@ -6,6 +6,6 @@ Firefly III is a self-hosted financial manager. It can help you keep track of ex
## Usage
Set `firefly_enabled: true` in your `group_vars/all.yml` file.
Set `firefly_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The Firefly III web interface can be found at http://ansible_nas_host_or_ip:8066.

View file

@ -6,6 +6,6 @@ Downloads TV and radio programmes from BBC iPlayer.
## Usage
Set `get_iplayer_enabled: true` in your `group_vars/all.yml` file.
Set `get_iplayer_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The get_iplayer web interface can be found at http://ansible_nas_host_or_ip:8182.

View file

@ -5,8 +5,8 @@ Homepage: [https://www.home-assistant.io/](https://www.home-assistant.io/)
## Usage
Set `homeassistant_enabled: true` in your `group_vars/all.yml` file.
Set `homeassistant_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access Home Assistant externally, don't forget to set `homeassistant_available_externally: "true"` in your `group_vars/all.yml` file.
If you want to access Home Assistant externally, don't forget to set `homeassistant_available_externally: "true"` in your `inventories/<your_inventory>/nas.yml` file.
The Home Assistant web interface can be found at http://ansible_nas_host_or_ip:8123.

View file

@ -6,6 +6,6 @@ Homebridge is a lightweight NodeJS server you can run on your home network that
## Usage
Set `homebridge_enabled: true` in your `group_vars/all.yml` file.
Set `homebridge_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The Homebridge web interface can be found at http://ansible_nas_host_or_ip:8087. The default username and password is 'admin' - change this after your first login!

View file

@ -6,6 +6,6 @@ Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr
## Usage
Set `jackett: true` in your `group_vars/all.yml` file.
Set `jackett: true` in your `inventories/<your_inventory>/nas.yml` file.
The Jackett web interface can be found at http://ansible_nas_host_or_ip:9117.

View file

@ -9,7 +9,7 @@ similar functionality.
## Usage
Set `jellyfin_enabled: true` in your `group_vars/all.yml` file. There are further
Set `jellyfin_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. There are further
parameters you can edit such as `movies_root` and `tv_root` lower down.
## Specific Configuration

View file

@ -6,9 +6,9 @@ Joomla! is an award-winning content management system (CMS), which enables you t
## Usage
Set `joomla_enabled: true` in your `group_vars/all.yml` file.
Set `joomla_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access Joomla externally, set `joomla_available_externally: "true"` in your `group_vars/all.yml` file.
If you want to access Joomla externally, set `joomla_available_externally: "true"` in your `inventories/<your_inventory>/nas.yml` file.
The Joomla web interface can be found at http://ansible_nas_host_or_ip:8181.

View file

@ -9,4 +9,4 @@ Lidarr is a music collection manager for Usenet and BitTorrent users. It can mon
## Usage
Set `lidarr_enabled: true` in your `group_vars/all.yml` file.
Set `lidarr_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.

View file

@ -6,6 +6,6 @@ MiniDLNA is server software with the aim of being fully compliant with DLNA/UPnP
## Usage
Set `minidlna_enabled: true` in your `group_vars/all.yml` file.
Set `minidlna_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The very basic MiniDLNA web interface can be found at http://ansible_nas_host_or_ip:8201.

View file

@ -6,7 +6,7 @@ Miniflux is a minimalist and opinionated feed reader.
## Usage
Set `miniflux_enabled: true` in your `group_vars/all.yml` file.
Set `miniflux_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The Miniflux web interface can be found at http://ansible_nas_host_or_ip:8070, the default username is `admin` and password `supersecure`.

View file

@ -6,5 +6,5 @@ Mosquitto is a lightweight open source MQTT message broker.
## Usage
Set `mosquitto_enabled: true` in your `group_vars/all.yml` file.
Set `mosquitto_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.

View file

@ -6,6 +6,6 @@ My Media lets you stream your music collection to your Amazon Echo or Amazon Dot
## Usage
Set `mymediaforalexa_enabled: true` in your `group_vars/all.yml` file.
Set `mymediaforalexa_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The My Media for Alexa web interface can be found at http://ansible_nas_host_or_ip:52051.

View file

@ -5,6 +5,8 @@ Homepage: [https://nextcloud.com](https://nextcloud.com)
## Usage
Set `nextcloud_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Tread carefully.
External access may require that you manually configure your Fully Qualified Domain Name (FQDN) as a trusted domain within the application. There is an evnironment variable set up for this in the "nextcloud task" which will most likely make manual configuration unneccessary. If you get the following [screenshot](https://docs.nextcloud.com/server/14/admin_manual/installation/installation_wizard.html#trusted-domains) warning when trying to access nextcloud externally you'll need to manually set it up.

View file

@ -6,6 +6,6 @@ The most efficient Usenet downloader. NZBGet is written in C++ and designed with
## Usage
Set `nzbget_enabled: true` in your `group_vars/all.yml` file.
Set `nzbget_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The NZBget web interface can be found at http://ansible_nas_host_or_ip:6789, the default username is `nzbget` and password `tegbzn6789`. Change this once you've logged in!

View file

@ -9,4 +9,4 @@ Ombi is a self-hosted web application that automatically gives your shared Plex
## Usage
Set `ombi_enabled: true` in your `group_vars/all.yml` file.
Set `ombi_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.

View file

@ -7,7 +7,7 @@ It allows you to connect many different IoT-Devices (which in this case means "I
## Usage
Set `openhab_enabled: true` in your `group_vars/all.yml` file.
Set `openhab_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
## Specific Configuration

View file

@ -6,7 +6,7 @@ Free and Open Source download manager written in Python and designed to be extre
.
## Usage
Set `pyload_enabled: true` in your `group_vars/all.yml` file.
Set `pyload_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
pyLoad's web interface can be found at http://ansible_nas_host_or_ip:8000

View file

@ -6,7 +6,7 @@ The Lounge is a self-hosted web IRC client.
## Usage
Set `thelounge_enabled: true` in your `group_vars/all.yml` file.
Set `thelounge_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
The Lounge web interface can be found at http://ansible_nas_host_or_ip:9000.

View file

@ -9,7 +9,7 @@ Older versions of Time Machine relied on AFP (netatalk) shares. Apple has deprec
## Usage
Set `timemachine_enabled: true` in your `group_vars/all.yml` file.
Set `timemachine_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Enabling Time Machine will result in the installation of Avahi on the NAS system (if it is not already installed) and a Time Machine service configuration file for Avahi will be added to the system (at `/etc/avahi/services/timemachine.service`) to allow for Time Machine discovery by Macs on the local network. Avahi runs on the system, rather than in a container, as the same Avahi instance can be used to announce any number of services.

View file

@ -11,7 +11,7 @@ See [External Access](configuration/external_access) for more info.
## Usage
Set `traefik_enabled: true` in your `group_vars/all.yml` file.
Set `traefik_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Traefik's web interface can be found at http://ansible_nas_host_or_ip:8083.

View file

@ -7,7 +7,7 @@ directly.
## Usage
Set `transmission_enabled: true`, or `transmission_with_openvpn_enabled: true` in your `group_vars/all.yml` file.
Set `transmission_enabled: true`, or `transmission_with_openvpn_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Transmission's web interface can be found at http://ansible_nas_host_or_ip:9091 (with VPN) or http://ansible_nas_host_or_ip:9092 (without VPN).

View file

@ -8,7 +8,7 @@ Ubooquity is a free, lightweight and easy-to-use home server for your comics and
## Usage
Set `ubooquity_enabled: true` in your `group_vars/all.yml` file.
Set `ubooquity_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Access the webui at http://<server>:2202/ubooquity by default. See specific configuration section below for information on setting up external access.

View file

@ -6,9 +6,9 @@ wallabag is a self-hostable PHP application allowing you to not miss any content
## Usage
Set `wallabag_enabled: true` in your `group_vars/all.yml` file.
Set `wallabag_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access Wallabag externally, don't forget to set `wallabag_available_externally: "true"` in your `group_vars/all.yml` file.
If you want to access Wallabag externally, don't forget to set `wallabag_available_externally: "true"` in your `inventories/<your_inventory>/nas.yml` file.
I reccomend using the mobile app, which will sync with this installation so you have access to your saved articles even if you don't have signal or wifi access.

View file

@ -6,10 +6,10 @@ A process for watching your Docker containers and automatically updating and res
## Usage
Set `watchtower_enabled: true` in your `group_vars/all.yml` file.
Set `watchtower_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
## Specific Configuration
By default Watchtower is configured to check daily at 5am for updates.
Various notification options are available, and can be configured by updating `watchtower_command` in your `group_vars/all.yml` file. A few examples are provided. The full set of options can be found at the [Watchtower GitHub project page](https://github.com/v2tec/watchtower).
Various notification options are available, and can be configured by updating `watchtower_command` in your `inventories/<your_inventory>/nas.yml` file. A few examples are provided. The full set of options can be found at the [Watchtower GitHub project page](https://github.com/v2tec/watchtower).