From c4ab198ead092dcd7486c39aa373954c639b6a29 Mon Sep 17 00:00:00 2001 From: Anarion Date: Tue, 28 Mar 2023 17:15:40 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=204=20missing=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- roles/get_iplayer/docs/get_iplayer.md | 11 +++++++++++ roles/netdata/docs/netdata.md | 11 +++++++++++ roles/sickchill/docs/sickchill.md | 12 ++++++++++++ roles/znc/docs/znc.md | 11 +++++++++++ 4 files changed, 45 insertions(+) create mode 100644 roles/get_iplayer/docs/get_iplayer.md create mode 100644 roles/netdata/docs/netdata.md create mode 100644 roles/sickchill/docs/sickchill.md create mode 100644 roles/znc/docs/znc.md diff --git a/roles/get_iplayer/docs/get_iplayer.md b/roles/get_iplayer/docs/get_iplayer.md new file mode 100644 index 00000000..48173c24 --- /dev/null +++ b/roles/get_iplayer/docs/get_iplayer.md @@ -0,0 +1,11 @@ +# Get_iPlayer + +Homepage: + +Downloads TV and radio programmes from BBC iPlayer. + +## Usage + +Set `get_iplayer_enabled: true` in your `inventories//nas.yml` file. + +The get_iplayer web interface can be found at . diff --git a/roles/netdata/docs/netdata.md b/roles/netdata/docs/netdata.md new file mode 100644 index 00000000..e8ef6884 --- /dev/null +++ b/roles/netdata/docs/netdata.md @@ -0,0 +1,11 @@ +# Netdata + +Homepage: + +An extremely comprehensive system monitoring solution. + +## Usage + +Set `netdata_enabled: true` in your `inventories//nas.yml` file. + +Netdata web interface can be found at . diff --git a/roles/sickchill/docs/sickchill.md b/roles/sickchill/docs/sickchill.md new file mode 100644 index 00000000..8fe2b75a --- /dev/null +++ b/roles/sickchill/docs/sickchill.md @@ -0,0 +1,12 @@ +# Sickchill + +Homepage: [Sickchill](https://sickchill.github.io/) + +SickChill is an automatic Video Library Manager for TV Shows. +It watches for new episodes of your favorite shows, and when they are posted it does its magic: automatic torrent/nzb searching, downloading, and processing at the qualities you want. + +## Usage + +Set `sickchill_enabled: true` in your `/inventories/[my inventory]/group_vars/nas.yml` file. + +The sickchill web interface can be found at `http://ansible_nas_host_or_ip:8081` by default diff --git a/roles/znc/docs/znc.md b/roles/znc/docs/znc.md new file mode 100644 index 00000000..bbcb5b54 --- /dev/null +++ b/roles/znc/docs/znc.md @@ -0,0 +1,11 @@ +# Znc + +Homepage: + +ZNC is an IRC network bouncer or BNC. It can detach the client from the actual IRC server, and also from selected channels. Multiple clients from different locations can connect to a single ZNC account simultaneously and therefore appear under the same nickname on IRC. It supports Transport Layer Security connections and IPv6. + +## Usage + +Set `znc_enabled: true` in your `inventories//nas.yml` file. Edit `znc_*` variables to suit your needs. For more advanced needs, edit the template config file (`templates\znc.conf.j2`) directly. + +Connect to ZNC using IRC at ansible_nas_host_or_ip:6677.