Mirrors/ansible-nas
2
0
Fork 0
mirror of https://github.com/davestephens/ansible-nas synced 2025-01-26 02:05:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update docs for mdx v3, other minor doc fixes

Browse source
This commit is contained in:
David Stephens 2023-12-30 21:36:33 +00:00
parent 06e2072e48
commit 732446fb49
89 changed files with 14894 additions and 272 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
website/blog/2022-09-19-welcome/index.md
View file

@ -5,4 +5,4 @@ authors: [davestephens]
tags: [ansible-nas, website]
---
It's about time Ansible-NAS had a proper website and domain name. This new [Docusaurus](https://docusaurus.io) based site is moving closer to that goal, served from <https://ansible-nas.io> via Github Pages.
It's about time Ansible-NAS had a proper website and domain name. This new [Docusaurus](https://docusaurus.io) based site is moving closer to that goal, served from [https://ansible-nas.io](https://ansible-nas.io) via Github Pages.

6
website/docs/applications/content-management/dokuwiki.md
View file

@ -3,12 +3,12 @@ title: "Dokuwiki"
description: "Open source wiki software that doesn't require a database"
---
Homepage: <https://www.dokuwiki.org/>
Homepage: [https://www.dokuwiki.org](https://www.dokuwiki.org)
DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.
## Usage
Set `dokuwiki_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `dokuwiki_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The DokuWiki web interface can be found at <http://ansible_nas_host_or_ip:8085>.
The DokuWiki web interface can be found at [http://ansible_nas_host_or_ip:8085](http://ansible_nas_host_or_ip:8085).

8
website/docs/applications/content-management/joomla.md
View file

@ -3,17 +3,17 @@ title: "Joomla"
description: "An award-winning content management system"
---
Homepage: <https://www.joomla.org/>
Homepage: [https://www.joomla.org](https://www.joomla.org)
Joomla! is an award-winning content management system (CMS), which enables you to build web sites and powerful online applications.
## Usage
Set `joomla_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `joomla_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
If you want to access Joomla externally, set `joomla_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access Joomla externally, set `joomla_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Joomla web interface can be found at <http://ansible_nas_host_or_ip:8181>.
The Joomla web interface can be found at [http://ansible_nas_host_or_ip:8181](http://ansible_nas_host_or_ip:8181).
## Specific Configuration

8
website/docs/applications/content-management/tiddlywiki.md
View file

@ -3,17 +3,17 @@ title: "TiddlyWiki"
description: "A notebook for capturing, organizing, and sharing information"
---
Homepage: <https://www.tiddlywiki.com/>
Homepage: [https://www.tiddlywiki.com](https://www.tiddlywiki.com)
TiddlyWiki is a unique non-linear notebook for capturing, organizing, and sharing complex information. Use it to keep your to-do list, to plan an essay or novel, or to organise your wedding. Record every thought that crosses your brain, or build a flexible and responsive website. Unlike conventional online services, TiddlyWiki lets you choose where to keep your data, guaranteeing that in the decades to come you will still be able to use the notes you take today.
## Usage
Set `tiddlywiki_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `tiddlywiki_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
If you want to access TiddlyWiki externally, set `tiddlywiki_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access TiddlyWiki externally, set `tiddlywiki_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The TiddlyWiki web interface can be found at <http://ansible_nas_host_or_ip:8092>.
The TiddlyWiki web interface can be found at [http://ansible_nas_host_or_ip:8092](http://ansible_nas_host_or_ip:8092).
## Specific Configuration

6
website/docs/applications/dashboards/dashy.md
View file

@ -2,7 +2,7 @@
title: "Dashy"
---
Homepage: <https://dashy.to/>
Homepage: [https://dashy.to](https://dashy.to)
Dashy is an open source, highly customizable, easy to use, privacy-respecting dashboard app.
It's packed full of useful features, to help you build your perfect dashboard. Including status checks, keyboard shortcuts, dynamic widgets, auto-fetched favicon icons and font-awesome support, built-in authentication, tons of themes, an interactive config editor, many display layouts plus loads more.
@ -10,6 +10,6 @@ All the code is free and open source, and everything is thoroughly documented, y
## Usage
Set `dashy_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `dashy_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Dashy web interface can be found at <http://ansible_nas_host_or_ip:8082>.
The Dashy web interface can be found at [http://ansible_nas_host_or_ip:8082](http://ansible_nas_host_or_ip:8082).

6
website/docs/applications/dashboards/heimdall.md
View file

@ -2,15 +2,15 @@
title: "Heimdall"
---
Homepage: <https://heimdall.site/>
Homepage: [https://heimdall.site](https://heimdall.site)
Heimdall Application Dashboard is a dashboard for all your web applications. It doesn't need to be limited to applications though, you can add links to anything you like
## Usage
Set `heimdall_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `heimdall_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Heimdall web interface can be found at <http://ansible_nas_host_or_ip:10080>.
The Heimdall web interface can be found at [http://ansible_nas_host_or_ip:10080](http://ansible_nas_host_or_ip:10080).
## Specific Configuration

12
website/docs/applications/dashboards/organizr.md
View file

@ -2,16 +2,12 @@
title: "Organizr"
---
Homepage: <https://organizr.app/>
Homepage: [https://organizr.app](https://organizr.app)
ORGANIZR aims to be your one stop shop for your Servers Frontend.
Do you have quite a bit of services running on your computer or server? Do you have a lot of bookmarks or have to memor$
TODO: finish this truncated description
HTPC/Homelab services organizer written in PHP.
## Usage
Set `organizr_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `organizr_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Organizr web interface can be found at <http://ansible_nas_host_or_ip:10081>.
The Organizr web interface can be found at [http://ansible_nas_host_or_ip:10081](http://ansible_nas_host_or_ip:10081).

8
website/docs/applications/development-tools/code-server.md
View file

@ -2,17 +2,17 @@
title: "Code Server"
---
Homepage: <https://code.visualstudio.com/>
Homepage: [https://code.visualstudio.com/](https://code.visualstudio.com/)
Code Server: <https://docs.linuxserver.io/images/docker-code-server>
Code Server: [https://docs.linuxserver.io/images/docker-code-server](https://docs.linuxserver.io/images/docker-code-server)
Run VSCode on you NAS, accessible through the browser. This web based IDE works exactly like VSCode Desktop would, but with the freedom of using it from anywhere.
## Usage
Set `code_server_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `code_server_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Code Server's web interface can be found at <http://ansible_nas_host_or_ip:8443>
Code Server's web interface can be found at [http://ansible_nas_host_or_ip:8443](http://ansible_nas_host_or_ip:8443)
## Specific Configuration

6
website/docs/applications/development-tools/drone_ci.md
View file

@ -4,16 +4,16 @@ title: "Drone CI"
Drone is a self-service Continuous Integration platform for busy development teams.
Check it out at <https://drone.io>.
Check it out at [https://drone.io](https://drone.io).
## Usage
Set `drone_ci_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `drone_ci_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Gitea (`gitea_enabled: true`) must be set up and running before attempting to set up Drone CI.
## Setup Tasks
An Oauth2 application must be set up in Gitea. Visit <https://docs.drone.io/server/provider/gitea/> for more info, then set `drone_ci_gitea_client_id` and `drone_ci_gitea_client_secret` accordingly. The Gitea Redirect URL will be `http://<ansible_nas_ip>:{{ drone_ci_port_http }}/login`
An Oauth2 application must be set up in Gitea. Visit [https://docs.drone.io/server/provider/gitea/](https://docs.drone.io/server/provider/gitea/) for more info, then set `drone_ci_gitea_client_id` and `drone_ci_gitea_client_secret` accordingly. The Gitea Redirect URL will be `http://<ansible_nas_ip>:{{ drone_ci_port_http }}/login`
Set `drone_ci_admin_user` to the same username as your user in Gitea.

6
website/docs/applications/development-tools/gitea.md
View file

@ -2,12 +2,12 @@
title: "Gitea"
---
Homepage: <https://gitea.io/>
Homepage: [https://gitea.io/](https://gitea.io/)
Gitea is a painless self-hosted Git service.
## Usage
Set `gitea_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `gitea_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Gitea web interface can be found at <http://ansible_nas_host_or_ip:3001>.
The Gitea web interface can be found at [http://ansible_nas_host_or_ip:3001](http://ansible_nas_host_or_ip:3001).

6
website/docs/applications/development-tools/gitlab.md
View file

@ -2,14 +2,14 @@
title: "GitLab"
---
Homepage: <https://docs.gitlab.com/omnibus/docker/>
Homepage: [https://docs.gitlab.com/omnibus/docker/](https://docs.gitlab.com/omnibus/docker/)
If Gitea isn't powerful enough for you then consider GitLab. It's a much more powerful (and consequently bigger) Git repository solution that includes a suite of code analytics. On the other hand it requires more RAM.
## Usage
Set `gitlab_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `gitlab_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
To make GitLab available externally via Traefik set `gitlab_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
To make GitLab available externally via Traefik set `gitlab_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The first time you run GitLab you'll be prompted for an account's password. The password is for GitLab's `root` administrator account. From there you can log in to create additional users and further configure the application.

6
website/docs/applications/development-tools/nomad.md
View file

@ -2,12 +2,12 @@
title: "Nomad"
---
Homepage: <https://www.nomadproject.io/>
Homepage: [https://www.nomadproject.io/](https://www.nomadproject.io/)
A simple and flexible scheduler and orchestrator to deploy and manage containers and non-containerised applications across on-prem and clouds at scale.
## Usage
Set `nomad_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `nomad_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Nomad's web interface can be found at <http://ansible_nas_host_or_ip:4646>
Nomad's web interface can be found at [http://ansible_nas_host_or_ip:4646](http://ansible_nas_host_or_ip:4646)

6
website/docs/applications/development-tools/woodpecker_ci.md
View file

@ -4,16 +4,16 @@ title: "Woodpecker CI"
Woodpecker is a simple CI engine with great extensibility.
Check it out at <https://woodpecker-ci.org/>.
Check it out at [https://woodpecker-ci.org/](https://woodpecker-ci.org/).
## Usage
Set `woodpecker_ci_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `woodpecker_ci_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Gitea (`gitea_enabled: true`) must be set up and running before attempting to set up Woodpecker CI.
## Setup Tasks
An Oauth2 application must be set up in Gitea. Visit <https://woodpecker-ci.org/docs/administration/forges/gitea> for more info, then set `woodpecker_ci_gitea_client` and `woodpecker_ci_gitea_secret` accordingly.
An Oauth2 application must be set up in Gitea. Visit [https://woodpecker-ci.org/docs/administration/forges/gitea](https://woodpecker-ci.org/docs/administration/forges/gitea) for more info, then set `woodpecker_ci_gitea_client` and `woodpecker_ci_gitea_secret` accordingly.
Set `woodpecker_ci_admin_user` to the same username as your user in Gitea.

4
website/docs/applications/download-tools/bazarr.md
View file

@ -2,13 +2,13 @@
title: "Bazarr"
---
Homepage: <https://github.com/morpheus65535/bazarr>
Homepage: [https://github.com/morpheus65535/bazarr](https://github.com/morpheus65535/bazarr)
Bazarr is a companion application to Sonarr and Radarr. It manages and downloads subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you.
## Usage
Set `bazarr_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `bazarr_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
## Specific Configuration

6
website/docs/applications/download-tools/couchpotato.md
View file

@ -2,12 +2,12 @@
title: "Couchpotato"
---
Homepage: <https://couchpota.to/>
Homepage: [https://couchpota.to/](https://couchpota.to/)
CouchPotato enables you to download movies automatically, easily and in the best quality as soon as they are available.
## Usage
Set `couchpotato_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `couchpotato_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The CouchPotato web interface can be found at <http://ansible_nas_host_or_ip:5050>.
The CouchPotato web interface can be found at [http://ansible_nas_host_or_ip:5050](http://ansible_nas_host_or_ip:5050).

8
website/docs/applications/download-tools/deluge.md
View file

@ -2,7 +2,7 @@
title: "Deluge"
---
Homepage: <http://deluge-torrent.org/>
Homepage: [http://deluge-torrent.org/](http://deluge-torrent.org/)
Deluge is a lightweight, Free Software, cross-platform BitTorrent client.
@ -13,10 +13,10 @@ Deluge is a lightweight, Free Software, cross-platform BitTorrent client.
## Usage
Set `deluge_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `deluge_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Deluge's web interface can be found at <http://ansible_nas_host_or_ip:8112>
Deluge's web interface can be found at [http://ansible_nas_host_or_ip:8112](http://ansible_nas_host_or_ip:8112)
Upon first viewing you will be prompted for a password. The default is `deluge` It is recommended that you change this password in the preferences menu.
**For more info visit: <https://dev.deluge-torrent.org/> & <https://github.com/linuxserver/docker-deluge/blob/master/README.md>
**For more info visit: [https://dev.deluge-torrent.org/](https://dev.deluge-torrent.org/) & [https://github.com/linuxserver/docker-deluge/blob/master/README.md](https://github.com/linuxserver/docker-deluge/blob/master/README.md)

6
website/docs/applications/download-tools/get_iplayer.md
View file

@ -2,12 +2,12 @@
title: "Get_iPlayer"
---
Homepage: <https://github.com/get-iplayer/get_iplayer>
Homepage: [https://github.com/get-iplayer/get_iplayer](https://github.com/get-iplayer/get_iplayer)
Downloads TV and radio programmes from BBC iPlayer.
## Usage
Set `get_iplayer_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `get_iplayer_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The get_iplayer web interface can be found at <http://ansible_nas_host_or_ip:8182>.
The get_iplayer web interface can be found at [http://ansible_nas_host_or_ip:8182](http://ansible_nas_host_or_ip:8182).

6
website/docs/applications/download-tools/jackett.md
View file

@ -2,12 +2,12 @@
title: "Jackett"
---
Homepage: <https://github.com/Jackett/Jackett>
Homepage: [https://github.com/Jackett/Jackett](https://github.com/Jackett/Jackett)
Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar, DuckieTV, qBittorrent, Nefarious etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.
## Usage
Set `jackett_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `jackett_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Jackett web interface can be found at <http://ansible_nas_host_or_ip:9117>.
The Jackett web interface can be found at [http://ansible_nas_host_or_ip:9117](http://ansible_nas_host_or_ip:9117).

4
website/docs/applications/download-tools/lidarr.md
View file

@ -2,10 +2,10 @@
title: "Lidarr"
---
Homepage: <https://lidarr.audio/>
Homepage: [https://lidarr.audio/](https://lidarr.audio/)
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
## Usage
Set `lidarr_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `lidarr_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.

10
website/docs/applications/download-tools/mylar.md
View file

@ -2,16 +2,16 @@
title: "Mylar"
---
Homepage: <https://github.com/evilhero/mylar>
Homepage: [https://github.com/evilhero/mylar](https://github.com/evilhero/mylar)
Docker Container: <https://hub.docker.com/r/linuxserver/mylar>
Docker Container: [https://hub.docker.com/r/linuxserver/mylar](https://hub.docker.com/r/linuxserver/mylar)
An automated Comic Book downloader (cbr/cbz) for use with SABnzbd, NZBGet and torrents
## Usage
Set `mylar_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `mylar_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
If you want to access Mylar externally, don't forget to set `mylar_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access Mylar externally, don't forget to set `mylar_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Mylar web interface can be found at <http://ansible_nas_host_or_ip:5858>.
The Mylar web interface can be found at [http://ansible_nas_host_or_ip:5858](http://ansible_nas_host_or_ip:5858).

6
website/docs/applications/download-tools/nzbget.md
View file

@ -2,12 +2,12 @@
title: "NZBGet"
---
Homepage: <https://nzbget.net/>
Homepage: [https://nzbget.net/](https://nzbget.net/)
The most efficient Usenet downloader. NZBGet is written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources.
## Usage
Set `nzbget_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `nzbget_enabled: true` in your `inventories/<your_inventory>/group_vars/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!
The NZBget web interface can be found at [http://ansible_nas_host_or_ip:6789](http://ansible_nas_host_or_ip:6789), the default username is `nzbget` and password `tegbzn6789`. Change this once you've logged in!

4
website/docs/applications/download-tools/ombi.md
View file

@ -2,10 +2,10 @@
title: "Ombi"
---
Homepage: <https://ombi.io/>
Homepage: [https://ombi.io/](https://ombi.io/)
Ombi is a self-hosted web application that automatically gives your shared Plex or Emby users the ability to request content by themselves! Ombi can be linked to multiple TV Show and Movie DVR tools to create a seamless end-to-end experience for your users.
## Usage
Set `ombi_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `ombi_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.

8
website/docs/applications/download-tools/overseerr.md
View file

@ -2,14 +2,14 @@
title: "Overseerr"
---
Homepage: <https://docs.overseerr.dev>
Homepage: [https://docs.overseerr.dev](https://docs.overseerr.dev)
Docker Container: <https://hub.docker.com/r/sctx/overseerr>
Docker Container: [https://hub.docker.com/r/sctx/overseerr](https://hub.docker.com/r/sctx/overseerr)
Overseerr is a free and open source software application for managing requests for your media library. It integrates with your existing services, such as Sonarr, Radarr, and Plex!
## Usage
Using overseerr: Set `overseerr_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Using overseerr: Set `overseerr_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The overseerr web interface can be found at <http://ansible_nas_host_or_ip:5055>.
The overseerr web interface can be found at [http://ansible_nas_host_or_ip:5055](http://ansible_nas_host_or_ip:5055).

4
website/docs/applications/download-tools/pyload.md
View file

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

4
website/docs/applications/download-tools/sabnzbd.md
View file

@ -2,7 +2,7 @@
title: "Sabnzbd"
---
Homepage: <https://sabnzbd.org/>
Homepage: [https://sabnzbd.org/](https://sabnzbd.org/)
The time tested Usenet downloader provided with FreeNAS. It just works for those migrating from FreeNAS.
@ -10,4 +10,4 @@ The time tested Usenet downloader provided with FreeNAS. It just works for those
Set `sabnzbd_enabled: true` in your `/inventories/[my inventory]/group_vars/nas.yml` file.
The Sabnzbd web interface can be found at <http://ansible_nas_host_or_ip:18080>. Use this interface to configure the software upon first connection.
The Sabnzbd web interface can be found at [http://ansible_nas_host_or_ip:18080](http://ansible_nas_host_or_ip:18080). Use this interface to configure the software upon first connection.

2
website/docs/applications/download-tools/sonarr.md
View file

@ -2,7 +2,7 @@
title: "Sonarr"
---
Homepage: <https://sonarr.tv/>
Homepage: [https://sonarr.tv/](https://sonarr.tv/)
**Sonarr** is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.

8
website/docs/applications/download-tools/transmission.md
View file

@ -2,16 +2,16 @@
title: "Transmission"
---
Homepage: <https://transmissionbt.com/>
Homepage: [https://transmissionbt.com/](https://transmissionbt.com/)
Transmission is a free BitTorrent client. Two versions are provided - one that tunnels through OpenVPN and one that connects
directly.
## Usage
Set `transmission_enabled: true`, or `transmission_with_openvpn_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `transmission_enabled: true`, or `transmission_with_openvpn_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Transmission's web interface can be found at <http://ansible_nas_host_or_ip:9091> (with OpenVPN) or <http://ansible_nas_host_or_ip:9092> (without OpenVPN).
Transmission's web interface can be found at [http://ansible_nas_host_or_ip:9091](http://ansible_nas_host_or_ip:9091) (with OpenVPN) or [http://ansible_nas_host_or_ip:9092](http://ansible_nas_host_or_ip:9092) (without OpenVPN).
## Specific Configuration
@ -24,4 +24,4 @@ openvpn_provider: NORDVPN
openvpn_config: uk686.nordvpn.com.udp
```
See <https://hub.docker.com/r/haugene/transmission-openvpn/> for supported VPN providers.
See [https://hub.docker.com/r/haugene/transmission-openvpn/](https://hub.docker.com/r/haugene/transmission-openvpn/) for supported VPN providers.

10
website/docs/applications/download-tools/utorrent.md
View file

@ -2,16 +2,16 @@
title: "uTorrent"
---
Homepage: <https://www.utorrent.com/>
Docker Container: <https://hub.docker.com/r/ekho/utorrent>
Homepage: [https://www.utorrent.com/](https://www.utorrent.com/)
Docker Container: [https://hub.docker.com/r/ekho/utorrent](https://hub.docker.com/r/ekho/utorrent)
## Usage
Set `utorrent_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `utorrent_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
If you want to access uTorrent externally, don't forget to set `utorrent_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access uTorrent externally, don't forget to set `utorrent_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The uTorrent web interface can be found at <http://ansible_nas_host_or_ip:8111/gui>:
The uTorrent web interface can be found at [http://ansible_nas_host_or_ip:8111/gui](http://ansible_nas_host_or_ip:8111/gui):
- Username: admin
- Password: *leave blank*

10
website/docs/applications/download-tools/youtubedlmaterial.md
View file

@ -2,18 +2,18 @@
title: "YouTubeDL-Material"
---
Homepage: <https://github.com/Tzahi12345/YoutubeDL-Material>
Docker Container: <https://hub.docker.com/r/tzahi12345/youtubedl-material>
Homepage: [https://github.com/Tzahi12345/YoutubeDL-Material](https://github.com/Tzahi12345/YoutubeDL-Material)
Docker Container: [https://hub.docker.com/r/tzahi12345/youtubedl-material](https://hub.docker.com/r/tzahi12345/youtubedl-material)
YoutubeDL-Material is a Material Design frontend for youtube-dl. It's coded using Angular 9 for the frontend, and Node.js on the backend.
## Usage
Set `youtubedlmaterial_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `youtubedlmaterial_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The YouTubeDL-Material web interface can be found at <http://ansible_nas_host_or_ip:8998>.
The YouTubeDL-Material web interface can be found at [http://ansible_nas_host_or_ip:8998](http://ansible_nas_host_or_ip:8998).
## Specific Configuration
A YouTube directory will be created in your configured downloads spot. YouTubeDL-Material downloads will be placed there.
You can change the download location via `inventories/<your_inventory>/nas.yml` file.
You can change the download location via `inventories/<your_inventory>/group_vars/nas.yml` file.

4
website/docs/applications/gaming/minecraft-server.md
View file

@ -2,13 +2,13 @@
title: "Minecraft Server"
---
Homepage: <https://www.minecraft.net/>
Homepage: [https://www.minecraft.net/](https://www.minecraft.net/)
The server version of the game Minecraft, running in a container. "Prepare for an adventure of limitless possibilities as you build, mine, battle mobs, and explore the ever-changing Minecraft landscape."
## Usage
Set `minecraft_server_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `minecraft_server_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Ansible NAS host or ip address should then be usable as a server within the Minecraft multiplayer game menu.

4
website/docs/applications/home-automation/esphome.md
View file

@ -8,7 +8,7 @@ ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configu
## Usage
Set `esphome_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `esphome_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
You can make esphome externally available, but the program has no security so this is strongly not advised
The EspHome web interface can be found at <http://ansible_nas_host_or_ip:6052>.
The EspHome web interface can be found at [http://ansible_nas_host_or_ip:6052](http://ansible_nas_host_or_ip:6052).

8
website/docs/applications/home-automation/homeassistant.md
View file

@ -2,14 +2,14 @@
title: "Home Assistant"
---
Homepage: <https://www.home-assistant.io/>
Homepage: [https://www.home-assistant.io/](https://www.home-assistant.io/)
Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts.
## Usage
Set `homeassistant_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `homeassistant_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.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.
If you want to access Home Assistant externally, don't forget to set `homeassistant_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Home Assistant web interface can be found at <http://ansible_nas_host_or_ip:8123>.
The Home Assistant web interface can be found at [http://ansible_nas_host_or_ip:8123](http://ansible_nas_host_or_ip:8123).

6
website/docs/applications/home-automation/homebridge.md
View file

@ -2,12 +2,12 @@
title: "Homebridge"
---
Homepage: <https://github.com/nfarina/homebridge>
Homepage: [https://github.com/nfarina/homebridge](https://github.com/nfarina/homebridge)
Homebridge is a lightweight NodeJS server you can run on your home network that emulates the iOS HomeKit API. It supports Plugins, which are community-contributed modules that provide a basic bridge from HomeKit to various 3rd-party APIs provided by manufacturers of "smart home" devices.
## Usage
Set `homebridge_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `homebridge_enabled: true` in your `inventories/<your_inventory>/group_vars/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!
The Homebridge web interface can be found at [http://ansible_nas_host_or_ip:8087](http://ansible_nas_host_or_ip:8087). The default username and password is 'admin' - change this after your first login!

4
website/docs/applications/home-automation/mosquitto.md
View file

@ -2,10 +2,10 @@
title: "Mosquitto"
---
Homepage: <https://mosquitto.org>
Homepage: [https://mosquitto.org](https://mosquitto.org)
Mosquitto is a lightweight open source MQTT message broker.
## Usage
Set `mosquitto_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `mosquitto_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.

4
website/docs/applications/home-automation/n8n.md
View file

@ -2,13 +2,13 @@
title: "Nodemation (n8n)"
---
Homepage: <https://n8n.io>
Homepage: [https://n8n.io](https://n8n.io)
Extendable workflow automation tool that enables you to connect anything to everything. More pragrmatically, it helps you interconnect API with each other to build your own information / work flows.
## Usage
Set `n8n_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `n8n_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
n8n is secured by default, he user and password can be set with:

4
website/docs/applications/home-automation/openhab.md
View file

@ -2,14 +2,14 @@
title: "openHAB"
---
Homepage: <https://www.openhab.org/>
Homepage: [https://www.openhab.org/](https://www.openhab.org/)
OpenHab is a vendor and technology agnostic open source automation software for your home.
It allows you to connect many different IoT-Devices (which in this case means "Intranet of Things") using custom bindings made by the community.
## Usage
Set `openhab_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `openhab_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
## Specific Configuration

6
website/docs/applications/media-serving/airsonic.md
View file

@ -2,15 +2,15 @@
title: "Airsonic"
---
Homepage: <https://airsonic.github.io/>
Homepage: [https://airsonic.github.io/](https://airsonic.github.io/)
Airsonic is a free, web-based media streamer, providing ubiquitous access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room
## Usage
Set `airsonic_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `airsonic_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Airsonic web interface can be found at <http://ansible_nas_host_or_ip:4040>.
The Airsonic web interface can be found at [http://ansible_nas_host_or_ip:4040](http://ansible_nas_host_or_ip:4040).
## Specific Configuration

6
website/docs/applications/media-serving/booksonic.md
View file

@ -2,7 +2,7 @@
title: "Booksonic"
---
Homepage: <https://booksonic.org/>
Homepage: [https://booksonic.org/](https://booksonic.org/)
Stream your audiobooks to any pc or android phone. Most of the functionality is also available on other platforms that have apps for subsonic.
@ -12,9 +12,9 @@ Get the Android app on [Google Play](https://play.google.com/store/apps/details?
## Usage
Set `booksonic_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `booksonic_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Booksonic web interface can be found at <http://ansible_nas_host_or_ip:4041>.
The Booksonic web interface can be found at [http://ansible_nas_host_or_ip:4041](http://ansible_nas_host_or_ip:4041).
## Specific Configuration

4
website/docs/applications/media-serving/calibre.md
View file

@ -2,13 +2,13 @@
title: "Calibre-web"
---
Homepage: <https://github.com/janeczku/calibre-web>
Homepage: [https://github.com/janeczku/calibre-web](https://github.com/janeczku/calibre-web)
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
## Usage
Set `calibre_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `calibre_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
## Specific Configuration

4
website/docs/applications/media-serving/emby.md
View file

@ -2,7 +2,7 @@
title: "Emby"
---
Homepage: <https://emby.media/>
Homepage: [https://emby.media/](https://emby.media/)
Emby is a mostly open-source media server with a client-server model. This
install for Ansible-NAS provides a server, which various clients can then
@ -13,7 +13,7 @@ similar functionality.
## Usage
Set `emby_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. There are further
Set `emby_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file. There are further
parameters you can edit such as `movies_root` and `tv_root` lower down.
## Specific Configuration

4
website/docs/applications/media-serving/jellyfin.md
View file

@ -2,7 +2,7 @@
title: "Jellyfin"
---
Homepage: <https://jellyfin.org/>
Homepage: [https://jellyfin.org/](https://jellyfin.org/)
Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!
@ -11,7 +11,7 @@ similar functionality.
## Usage
Set `jellyfin_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. There are further
Set `jellyfin_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file. There are further
parameters you can edit such as `movies_root`, `tv_root` or `music_root` lower down
## Specific Configuration

8
website/docs/applications/media-serving/komga.md
View file

@ -2,14 +2,14 @@
title: "Komga"
---
Homepage: <https://komga.org/>
Homepage: [https://komga.org/](https://komga.org/)
Docker Image: <https://hub.docker.com/r/gotson/komga>
Docker Image: [https://hub.docker.com/r/gotson/komga](https://hub.docker.com/r/gotson/komga)
Komga is a media server for your comics, mangas, BDs and magazines.
## Usage
Set `komga_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `komga_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Access the webui at <http://ansible_nas_host_or_ip:8088> by default.
Access the webui at [http://ansible_nas_host_or_ip:8088](http://ansible_nas_host_or_ip:8088) by default.

6
website/docs/applications/media-serving/minidlna.md
View file

@ -2,12 +2,12 @@
title: "MiniDLNA"
---
Homepage: <https://sourceforge.net/projects/minidlna/>
Homepage: [https://sourceforge.net/projects/minidlna/](https://sourceforge.net/projects/minidlna/)
MiniDLNA is server software with the aim of being fully compliant with DLNA/UPnP clients. The MiniDNLA daemon serves media files (music, pictures, and video) to clients on a network. Example clients include applications such as Totem and Kodi, and devices such as portable media players, Smartphones, Televisions, and gaming systems (such as PS3 and Xbox 360).
## Usage
Set `minidlna_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `minidlna_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The very basic MiniDLNA web interface can be found at <http://ansible_nas_host_or_ip:8201>.
The very basic MiniDLNA web interface can be found at [http://ansible_nas_host_or_ip:8201](http://ansible_nas_host_or_ip:8201).

6
website/docs/applications/media-serving/mymediaforalexa.md
View file

@ -2,12 +2,12 @@
title: "My Media for Alexa"
---
Homepage: <https://www.mymediaalexa.com/>
Homepage: [https://www.mymediaalexa.com/](https://www.mymediaalexa.com/)
My Media lets you stream your music collection to your Amazon Echo or Amazon Dot without having to upload all your music collection to the Cloud. This keeps your music under your control.
## Usage
Set `mymediaforalexa_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `mymediaforalexa_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The My Media for Alexa web interface can be found at <http://ansible_nas_host_or_ip:52051>.
The My Media for Alexa web interface can be found at [http://ansible_nas_host_or_ip:52051](http://ansible_nas_host_or_ip:52051).

6
website/docs/applications/media-serving/navidrome.md
View file

@ -2,12 +2,12 @@
title: "Navidrome"
---
Homepage: <https://www.navidrome.org/>
Homepage: [https://www.navidrome.org/](https://www.navidrome.org/)
Navidrome is an open source web-based music collection server and streamer that is compatible with Subsonic/Airsonic. It gives you freedom to listen to your music collection from any browser or mobile device. It's like your personal Spotify!
## Usage
Set `navidrome_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `navidrome_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Navidrome web interface can be found at <http://ansible_nas_host_or_ip:4533>.
The Navidrome web interface can be found at [http://ansible_nas_host_or_ip:4533](http://ansible_nas_host_or_ip:4533).

6
website/docs/applications/media-serving/plex.md
View file

@ -2,15 +2,15 @@
title: "Plex"
---
Homepage: <https://www.plex.tv/>
Homepage: [https://www.plex.tv/](https://www.plex.tv/)
Plex is a personal media server that also provides access to several external movie, web show, and podcast services. Allows you to stream music too. Apps for many devices, including e.g. chromecast integration.
## Usage
Set `plex_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `plex_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Plex web interface can be found at <http://ansible_nas_host_or_ip:32400/web/index.html>.
The Plex web interface can be found at [http://ansible_nas_host_or_ip:32400/web/index.html](http://ansible_nas_host_or_ip:32400/web/index.html).
## Specific Configuration

8
website/docs/applications/media-serving/pytivo.md
View file

@ -3,20 +3,20 @@ title: "PyTivo"
---
Project Homepage:
<https://github.com/lucasnz/pytivo>
[https://github.com/lucasnz/pytivo](https://github.com/lucasnz/pytivo)
Docker Homepage:
<https://hub.docker.com/r/pinion/docker-pytivo>
[https://hub.docker.com/r/pinion/docker-pytivo](https://hub.docker.com/r/pinion/docker-pytivo)
PyTivo is both an HMO and GoBack server. Similar to TiVo Desktop pyTivo
loads many standard video compression codecs and outputs mpeg2 video to
the TiVo. However, pyTivo is able to load MANY more file types than TiVo
Desktop. <http://pytivo.org/>
Desktop. [http://pytivo.org/](http://pytivo.org/)
## Usage
Set `pytivo_enabled: true` in your `group_vars/all.yml` file. The PyTivo
web interface can be found at <http://ansible_nas_host_or_ip:9032>.
web interface can be found at [http://ansible_nas_host_or_ip:9032](http://ansible_nas_host_or_ip:9032).
## Specific Configuration

6
website/docs/applications/media-serving/tautulli.md
View file

@ -2,12 +2,12 @@
title: "Tautulli"
---
Homepage: <https://tautulli.com/>
Homepage: [https://tautulli.com/](https://tautulli.com/)
Tautulli allows you to monitor your Plex Media Server.
## Usage
Set `tautulli_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `tautulli_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Tautulli web interface can be found at <http://ansible_nas_host_or_ip:8181>.
The Tautulli web interface can be found at [http://ansible_nas_host_or_ip:8181](http://ansible_nas_host_or_ip:8181).

8
website/docs/applications/media-serving/threadfin.md
View file

@ -2,11 +2,11 @@
title: "Ubooquity"
---
Homepage: <https://github.com/Threadfin/Threadfin>
Homepage: [https://github.com/Threadfin/Threadfin](https://github.com/Threadfin/Threadfin)
Documentation: <https://github.com/xteve-project/xTeVe-Documentation/blob/master/en/configuration.md>
Documentation: [https://github.com/xteve-project/xTeVe-Documentation/blob/master/en/configuration.md](https://github.com/xteve-project/xTeVe-Documentation/blob/master/en/configuration.md)
Docker Image: <https://hub.docker.com/r/fyb3roptik/threadfin>
Docker Image: [https://hub.docker.com/r/fyb3roptik/threadfin](https://hub.docker.com/r/fyb3roptik/threadfin)
Threadfin is a M3U proxy server for Plex, Emby, Jellyfin and any client and provider which supports the .TS and .M3U8 (HLS) streaming formats.
@ -16,4 +16,4 @@ Threadfin emulates a SiliconDust HDHomeRun OTA tuner, which allows it to expose
Set `threadfin_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Access the webui at <http://ansible_nas_host_or_ip:34400/web> by default. See specific configuration section below for information on setting up external access.
Access the webui at [http://ansible_nas_host_or_ip:34400/web](http://ansible_nas_host_or_ip:34400/web) by default. See specific configuration section below for information on setting up external access.

14
website/docs/applications/media-serving/ubooquity.md
View file

@ -2,26 +2,26 @@
title: "Ubooquity"
---
Homepage: <https://vaemendis.net/ubooquity/>
Homepage: [https://vaemendis.net/ubooquity/](https://vaemendis.net/ubooquity/)
Documentation: <https://vaemendis.github.io/ubooquity-doc/>
Documentation: [https://vaemendis.github.io/ubooquity-doc/](https://vaemendis.github.io/ubooquity-doc/)
Docker Image: <https://hub.docker.com/r/linuxserver/ubooquity/>
Docker Image: [https://hub.docker.com/r/linuxserver/ubooquity/](https://hub.docker.com/r/linuxserver/ubooquity/)
Ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer.
## Usage
Set `ubooquity_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `ubooquity_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Access the webui at <http://ansible_nas_host_or_ip:2202/ubooquity> by default. See specific configuration section below for information on setting up external access.
Access the webui at [http://ansible_nas_host_or_ip:2202/ubooquity](http://ansible_nas_host_or_ip:2202/ubooquity) by default. See specific configuration section below for information on setting up external access.
## Specific Configuration
Important note: if you want to access Ubooquity externally through Traefik (at ubooquity.yourdomain.tld), you need to go to <http://ansible_nas_host_or_ip:2203/ubooquity/admin> and set the reverse proxy prefix to blank under "Advanced". Otherwise you will need to append "/ubooquity" to the url in order to access.
Important note: if you want to access Ubooquity externally through Traefik (at ubooquity.yourdomain.tld), you need to go to [http://ansible_nas_host_or_ip:2203/ubooquity/admin](http://ansible_nas_host_or_ip:2203/ubooquity/admin) and set the reverse proxy prefix to blank under "Advanced". Otherwise you will need to append "/ubooquity" to the url in order to access.
### Admin login
The admin portal is not exposed through Traefik. You can access the admin portal on port 2203.
Upon your first run, the address is <http://ansible_nas_host_or_ip:2203/ubooquity/admin>. You will be able to set the admin password here.
Upon your first run, the address is [http://ansible_nas_host_or_ip:2203/ubooquity/admin](http://ansible_nas_host_or_ip:2203/ubooquity/admin). You will be able to set the admin password here.

6
website/docs/applications/monitoring/glances.md
View file

@ -2,15 +2,15 @@
title: "Glances"
---
Homepage: <https://nicolargo.github.io/glances/>
Homepage: [https://nicolargo.github.io/glances/](https://nicolargo.github.io/glances/)
Glances is a cross-platform system monitoring tool written in Python.
## Usage
Set `glances_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `glances_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Glances web interface can be found at <http://ansible_nas_host_or_ip:61208>.
The Glances web interface can be found at [http://ansible_nas_host_or_ip:61208](http://ansible_nas_host_or_ip:61208).
## Specific Configuration

10
website/docs/applications/monitoring/speedtest.md
View file

@ -2,16 +2,16 @@
title: "Speedtest-Tracker"
---
Homepage: <https://github.com/henrywhitaker3/Speedtest-Tracker>
Homepage: [https://github.com/henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker)
Docker Container: <https://hub.docker.com/r/henrywhitaker3/speedtest-tracker>
Docker Container: [https://hub.docker.com/r/henrywhitaker3/speedtest-tracker](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker)
Continuously track your internet speed
## Usage
Set `speedtest_tracker_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `speedtest_tracker_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
If you want to access Speedtest-Tracker externally, don't forget to set `speedtest_tracker_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access Speedtest-Tracker externally, don't forget to set `speedtest_tracker_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Speedtest-Tracker interface can be found at <http://ansible_nas_host_or_ip:8765>.
The Speedtest-Tracker interface can be found at [http://ansible_nas_host_or_ip:8765](http://ansible_nas_host_or_ip:8765).

6
website/docs/applications/monitoring/stats.md
View file

@ -8,8 +8,8 @@ Telegraf also exposes an InfluxDB endpoint for applications that require it.
## Usage
Set `stats_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. If you want to gather metrics on your internet connection, enable `stats_internet_speed_test_enabled` too.
Set `stats_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file. If you want to gather metrics on your internet connection, enable `stats_internet_speed_test_enabled` too.
If you want to access Grafana externally, set `stats_grafana_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file. If you want to access Promethehus externally, set `stats_prometheus_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access Grafana externally, set `stats_grafana_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file. If you want to access Promethehus externally, set `stats_prometheus_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Grafana web interface can be found at <http://ansible_nas_host_or_ip:3000>, Prometheus can be found at <http://ansible_nas_host_or_ip:9090>
The Grafana web interface can be found at [http://ansible_nas_host_or_ip:3000](http://ansible_nas_host_or_ip:3000), Prometheus can be found at [http://ansible_nas_host_or_ip:9090](http://ansible_nas_host_or_ip:9090)

6
website/docs/applications/monitoring/wireshark.md
View file

@ -2,12 +2,12 @@
title: "Wireshark"
---
Homepage: <https://www.wireshark.org/>
Homepage: [https://www.wireshark.org/](https://www.wireshark.org/)
Wireshark is the world’s foremost and widely-used network protocol analyzer. It lets you see what’s happening on your network at a microscopic level and is the de facto (and often de jure) standard across many commercial and non-profit enterprises, government agencies, and educational institutions. Wireshark development thrives thanks to the volunteer contributions of networking experts around the globe and is the continuation of a project started by Gerald Combs in 1998.
## Usage
Set `wireshark_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `wireshark_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Wireshark web interface can be found at <http://ansible_nas_host_or_ip:3000>.
The Wireshark web interface can be found at [http://ansible_nas_host_or_ip:3000](http://ansible_nas_host_or_ip:3000).

6
website/docs/applications/news/freshrss.md
View file

@ -2,7 +2,7 @@
title: "FreshRSS"
---
Homepage: <https://freshrss.org/>
Homepage: [https://freshrss.org/](https://freshrss.org/)
FreshRSS is a self-hosted RSS feed aggregator like Leed or Kriss Feed.
@ -18,6 +18,6 @@ Finally, it supports extensions for further tuning.
## Usage
Set `freshrss_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `freshrss_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The FreshRSS web interface can be found at <http://ansible_nas_host_or_ip:8089>.
The FreshRSS web interface can be found at [http://ansible_nas_host_or_ip:8089](http://ansible_nas_host_or_ip:8089).

6
website/docs/applications/news/miniflux.md
View file

@ -1,14 +1,14 @@
# Miniflux
Homepage: <https://miniflux.app/>
Homepage: [https://miniflux.app/](https://miniflux.app/)
Miniflux is a minimalist and opinionated feed reader.
## Usage
Set `miniflux_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `miniflux_enabled: true` in your `inventories/<your_inventory>/group_vars/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`.
The Miniflux web interface can be found at [http://ansible_nas_host_or_ip:8070](http://ansible_nas_host_or_ip:8070), the default username is `admin` and password `supersecure`.
## Specific Configuration

6
website/docs/applications/news/rssbridge.md
View file

@ -2,7 +2,7 @@
title: "RSS-Bridge"
---
Homepage: <https://rss-bridge.github.io/rss-bridge/>
Homepage: [https://rss-bridge.github.io/rss-bridge/](https://rss-bridge.github.io/rss-bridge/)
RSS-Bridge is a PHP project capable of generating RSS and Atom feeds for websites that don't have one. It can be used on webservers or as a stand-alone application in CLI mode.
@ -10,6 +10,6 @@ Important: RSS-Bridge is not a feed reader or feed aggregator, but a tool to gen
## Usage
Set `rssbridge_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `rssbridge_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The RSS-Bridge web interface can be found at <http://ansible_nas_host_or_ip:8091>.
The RSS-Bridge web interface can be found at [http://ansible_nas_host_or_ip:8091](http://ansible_nas_host_or_ip:8091).

4
website/docs/applications/observability/grafana.md
View file

@ -2,7 +2,7 @@
title: "Grafana"
---
Homepage: <https://grafana.com/>
Homepage: [https://grafana.com/](https://grafana.com/)
Docker image: [Grafana](https://hub.docker.com/r/grafana/grafana)
@ -12,4 +12,4 @@ Query, visualize, alert on, and understand your data no matter where it’s stor
Set `stats_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Grafana's web interface can be found at <http://ansible_nas_host_or_ip:3000>.
Grafana's web interface can be found at [http://ansible_nas_host_or_ip:3000](http://ansible_nas_host_or_ip:3000).

8
website/docs/applications/other/bitwarden.md
View file

@ -2,19 +2,19 @@
title: "Bitwarden(_rs)"
---
Homepage: <https://github.com/dani-garcia/bitwarden_rs>
Homepage: [https://github.com/dani-garcia/bitwarden_rs](https://github.com/dani-garcia/bitwarden_rs)
Bitwarden: <https://bitwarden.com/>
Bitwarden: [https://bitwarden.com/](https://bitwarden.com/)
This is a Bitwarden server API implementation written in Rust compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.
## Usage
Set `bitwarden_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `bitwarden_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
## Specific Configuration
Make sure you set your admin token! It is `bitwarden_admin_token` in `group_vars/all.yml` file. The string you put here will be the login to the admin section of your Bitwarden installation (<https://bitwarden.ansiblenasdomain.tld/admin>). This token can be anything, but it's recommended to use a long, randomly generated string of characters, for example running:
Make sure you set your admin token! It is `bitwarden_admin_token` in `group_vars/all.yml` file. The string you put here will be the login to the admin section of your Bitwarden installation ([https://bitwarden.ansiblenasdomain.tld/admin](https://bitwarden.ansiblenasdomain.tld/admin)). This token can be anything, but it's recommended to use a long, randomly generated string of characters, for example running:
`openssl rand -base64 48`.
To create a user, you need to set `bitwarden_allow_signups` to `true` in your `all.yml`, and re-run the playbook to reprovision the container. Once you've created your users, set `bitwarden_allow_signups` back to `false` and run again.

6
website/docs/applications/other/firefly.md
View file

@ -2,12 +2,12 @@
title: "Firefly III"
---
Homepage: <https://firefly-iii.org/>
Homepage: [https://firefly-iii.org/](https://firefly-iii.org/)
Firefly III is a self-hosted financial manager. It can help you keep track of expenses, income, budgets and everything in between. It supports credit cards, shared household accounts and savings accounts. It's pretty fancy. You should use it to save and organize money.
## Usage
Set `firefly_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `firefly_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Firefly III web interface can be found at <http://ansible_nas_host_or_ip:8066>.
The Firefly III web interface can be found at [http://ansible_nas_host_or_ip:8066](http://ansible_nas_host_or_ip:8066).

8
website/docs/applications/other/gotify.md
View file

@ -2,17 +2,17 @@
title: "Gotify"
---
Homepage: <https://gotify.net/>
Homepage: [https://gotify.net/](https://gotify.net/)
A simple server for sending and receiving messages in real-time per WebSocket. (Includes a sleek web-ui)
## Usage
Set `gotify_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `gotify_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Gotify web interface can be found at <http://ansible_nas_host_or_ip:2346>.
The Gotify web interface can be found at [http://ansible_nas_host_or_ip:2346](http://ansible_nas_host_or_ip:2346).
Android client: [https://play.google.com/store/apps/details?id=com.github.gotify](https://play.google.com/store/apps/details?id=com.github.gotify)
iOS client: n/a
Chrome extension: n/a
Firefox extension: <https://addons.mozilla.org/en-US/firefox/addon/gotify-for-firefox/>
Firefox extension: [https://addons.mozilla.org/en-US/firefox/addon/gotify-for-firefox/](https://addons.mozilla.org/en-US/firefox/addon/gotify-for-firefox/)

4
website/docs/applications/other/guacamole.md
View file

@ -2,13 +2,13 @@
title: "Guacamole"
---
Homepage: <https://guacamole.apache.org/>
Homepage: [https://guacamole.apache.org/](https://guacamole.apache.org/)
Apache Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH.
## Usage
Set `guacamole_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `guacamole_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
## Specific Configuration

6
website/docs/applications/other/hello_world.md
View file

@ -2,15 +2,15 @@
title: "Hello World"
---
Homepage: <https://www.example.com/>
Homepage: [https://www.example.com/](https://www.example.com/)
A few sentences here about what the application does.
## Usage
Set `hello_world_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `hello_world_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Hello World web interface can be found at <http://ansible_nas_host_or_ip:9999>.
The Hello World web interface can be found at [http://ansible_nas_host_or_ip:9999](http://ansible_nas_host_or_ip:9999).
## Specific Configuration

6
website/docs/applications/other/mealie.md
View file

@ -2,12 +2,12 @@
title: "Mealie"
---
Homepage: <https://docs.mealie.io/>
Homepage: [https://docs.mealie.io/](https://docs.mealie.io/)
A self-hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family.
## Usage
Set `mealie_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `mealie_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Mealie web interface can be found at <http://ansible_nas_host_or_ip:9925>.
The Mealie web interface can be found at [http://ansible_nas_host_or_ip:9925](http://ansible_nas_host_or_ip:9925).

4
website/docs/applications/other/mumble.md
View file

@ -1,12 +1,12 @@
# Mumble
Homepage: <https://www.mumble.info/>
Homepage: [https://www.mumble.info/](https://www.mumble.info/)
Mumble is a free, open source, low latency, high quality voice chat application.
## Usage
Set `mumble_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `mumble_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The configuration here applies a server password, via `mumble_server_password`, to
the Mumble instance, so that if you make this application available externally it won't be
accessible to everyone by default. That being said, it is **strongly** encouraged that

4
website/docs/applications/other/nextcloud.md
View file

@ -2,11 +2,11 @@
title: "Nextcloud"
---
Homepage: <https://nextcloud.com>
Homepage: [https://nextcloud.com](https://nextcloud.com)
## Usage
Set `nextcloud_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `nextcloud_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Tread carefully.

4
website/docs/applications/other/octoprint.md
View file

@ -1,12 +1,12 @@
---
title: "Octoprint"
---
Homepage: <https://octoprint.org/>
Homepage: [https://octoprint.org/](https://octoprint.org/)
Octoprint is a control and monitoring application for your 3D printer. You can start and stop print jobs, view your webcam feed, move the print head and extruder manually and check your gcode files, all from a single web interface. Octoprint doesn't require modifications on the printer firmware, just make sure your NAS is phisically connected to it with a usb cable.
## Usage
Connect the printer to your NAS, and take note of where the serial interface is mounted (usually it's automounted in `/dev/ttyUSB0`). Set `octoprint_enabled: true` in your `inventories/<your_inventory>/nas.yml` file, as well as the `octoprint_printer_mountpoint` variable if your printer doesn't mount to the default location.
Connect the printer to your NAS, and take note of where the serial interface is mounted (usually it's automounted in `/dev/ttyUSB0`). Set `octoprint_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file, as well as the `octoprint_printer_mountpoint` variable if your printer doesn't mount to the default location.
If you want to also have a webcam feed, attach one to your NAS and take note of its mountpoint as well (usually `/dev/video0`). Set `octoprint_enable_webcam: true` and add a `octoprint_webcam_mountpoint` variable if the webcam doesn't mount to the default location.

6
website/docs/applications/other/paperless_ng.md
View file

@ -2,7 +2,7 @@
title: "Paperless-ng"
---
Homepage: <https://github.com/jonaswinkler/paperless-ng>
Homepage: [https://github.com/jonaswinkler/paperless-ng](https://github.com/jonaswinkler/paperless-ng)
Paperless is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents.
@ -10,9 +10,9 @@ Paperless-ng is a fork of the original project, adding a new interface and many
## Usage
Set `paperless_ng_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `paperless_ng_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The paperless-ng web interface can be found at <http://ansible_nas_host_or_ip:16922>.
The paperless-ng web interface can be found at [http://ansible_nas_host_or_ip:16922](http://ansible_nas_host_or_ip:16922).
### Create the superuser

6
website/docs/applications/other/piwigo.md
View file

@ -8,11 +8,11 @@ Piwigo is open source photo gallery software for the web. Designed for organisat
## Usage
Set `piwigo_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `piwigo_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
If you want to access Piwigo externally, set `piwigo_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
If you want to access Piwigo externally, set `piwigo_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Piwigo web interface can be found at <http://ansible_nas_host_or_ip:16923>.
The Piwigo web interface can be found at [http://ansible_nas_host_or_ip:16923](http://ansible_nas_host_or_ip:16923).
## Specific Configuration

6
website/docs/applications/other/thelounge.md
View file

@ -2,15 +2,15 @@
title: "The Lounge"
---
Homepage: <https://thelounge.chat/>
Homepage: [https://thelounge.chat/](https://thelounge.chat/)
The Lounge is a self-hosted web IRC client.
## Usage
Set `thelounge_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `thelounge_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Lounge web interface can be found at <http://ansible_nas_host_or_ip:9000>.
The Lounge web interface can be found at [http://ansible_nas_host_or_ip:9000](http://ansible_nas_host_or_ip:9000).
## Specific Configuration

6
website/docs/applications/other/traefik.md
View file

@ -2,7 +2,7 @@
title: "Traefik"
---
Homepage: <https://traefik.io>
Homepage: [https://traefik.io](https://traefik.io)
Traefik is a reverse proxy used to provide external access to your Ansible-NAS box. Additionally, Traefik will automatically request and renew SSL certificates for you.
@ -13,9 +13,9 @@ See [External Access](../../getting-started/external-access.md) for more info.
## Usage
Set `traefik_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `traefik_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Traefik's web interface can be found at <http://ansible_nas_host_or_ip:8083>.
Traefik's web interface can be found at [http://ansible_nas_host_or_ip:8083](http://ansible_nas_host_or_ip:8083).
## Specific Configuration

2
website/docs/applications/other/virtual_desktop.md
View file

@ -6,7 +6,7 @@ It's possible to run a cut down desktop within a Docker container. We use [Ratty
## Usage
Set `virtual_desktop_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `virtual_desktop_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
## Specific Configuration

8
website/docs/applications/other/wallabag.md
View file

@ -2,18 +2,18 @@
title: "Wallabag"
---
Homepage: <https://www.wallabag.org/>
Homepage: [https://www.wallabag.org/](https://www.wallabag.org/)
wallabag is a self-hostable PHP application allowing you to not miss any content anymore. Click, save and read it when you can. It extracts content so that you can read it when you have time.
## Usage
Set `wallabag_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `wallabag_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.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.
If you want to access wallabag externally, don't forget to set `wallabag_available_externally: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
I recommend 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.
The default credentials are wallabag:wallabag
The wallabag web interface can be found at <http://ansible_nas_host_or_ip:7780>.
The wallabag web interface can be found at [http://ansible_nas_host_or_ip:7780](http://ansible_nas_host_or_ip:7780).

6
website/docs/applications/system-tools/cloudcmd.md
View file

@ -2,15 +2,15 @@
title: "Cloud Commander"
---
Homepage: <https://cloudcmd.io/>
Homepage: [https://cloudcmd.io/](https://cloudcmd.io/)
Cloud Commander is a file manager for the web. It includes a command-line console and a text editor. Cloud Commander helps you manage your server and work with files, directories and programs in a web browser from any computer, mobile or tablet.
## Usage
Set `cloudcmd_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `cloudcmd_enabled: true` in your `inventories/<your_inventory>/group_vars/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 `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 `inventories/<your_inventory>/group_vars/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).

8
website/docs/applications/system-tools/cloudflare_ddns.md
View file

@ -2,21 +2,21 @@
title: "Cloudflare DDNS"
---
Homepage: <https://github.com/joshuaavalon/docker-cloudflare>
Homepage: [https://github.com/joshuaavalon/docker-cloudflare](https://github.com/joshuaavalon/docker-cloudflare)
Cloudflare: <https://www.cloudflare.com>
Cloudflare: [https://www.cloudflare.com](https://www.cloudflare.com)
If you want your Ansible-NAS accessible externally then you'll need a domain name. You'll also need to set a wildcard
host A record to point to your static IP, or enable this container to automatically update Cloudflare with your dynamic IP address.
## Usage
Set `cloudflare_ddns_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `cloudflare_ddns_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Set `cloudflare_token` to the one you grab from the Cloudflare UI (more below).
## Specific Configuration
Make sure you set your domain (if different than the ansible-nas default) and access token details within your `inventories/<your_inventory>/nas.yml` file. If you need to create an API token, see [https://github.com/joshuaavalon/docker-cloudflare/#api-token](https://github.com/joshuaavalon/docker-cloudflare/#api-token) for instructions.
Make sure you set your domain (if different than the ansible-nas default) and access token details within your `inventories/<your_inventory>/group_vars/nas.yml` file. If you need to create an API token, see [https://github.com/joshuaavalon/docker-cloudflare/#api-token](https://github.com/joshuaavalon/docker-cloudflare/#api-token) for instructions.
Cloudflare has deprecated global API key authentication. If you have an older ansible-nas configuration using a global API key, you can upgrade to the API token-based authentication by removing the `cloudflare_api_key` variable from your local `nas.yml` configuration file and setting the `cloudflare_token` variable appropriately.

6
website/docs/applications/system-tools/duplicacy.md
View file

@ -2,15 +2,15 @@
title: "Duplicacy"
---
Homepage: <https://duplicacy.com/>
Homepage: [https://duplicacy.com/](https://duplicacy.com/)
Duplicacy is a next-generation, cross-platform, cloud backup tool. Duplicacy backs up your files to many cloud storages with client-side encryption and the highest level of deduplication.
## Usage
Set `duplicacy_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `duplicacy_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Duplicacy's web interface can be found at <http://ansible_nas_host_or_ip:3875>.
Duplicacy's web interface can be found at [http://ansible_nas_host_or_ip:3875](http://ansible_nas_host_or_ip:3875).
## Specific Configuration

6
website/docs/applications/system-tools/duplicati.md
View file

@ -2,12 +2,12 @@
title: "Duplicati"
---
Homepage: <https://www.duplicati.com/>
Homepage: [https://www.duplicati.com/](https://www.duplicati.com/)
Duplicati is free backup software to store encrypted backups online For Windows, macOS and Linux
## Usage
Set `duplicati_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `duplicati_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Duplicati web interface can be found at <http://ansible_nas_host_or_ip:8200>.
The Duplicati web interface can be found at [http://ansible_nas_host_or_ip:8200](http://ansible_nas_host_or_ip:8200).

6
website/docs/applications/system-tools/healthchecks.io.md
View file

@ -2,12 +2,12 @@
title: "Healthchecks.io"
---
Homepage: <https://healthchecks.io/>
Homepage: [https://healthchecks.io/](https://healthchecks.io/)
A simple cronjob that uses `curl` to ping a given endpoint on the `healthchecks.io` servers. You can choose how often it should ping the endpoint, and what happens when it doesn't. Email/Slack/Telegram and many more services can be integrated.
## Usage
Create your own project on <https://healthchecks.io/>, and set both the time between pings and the grace time. Set your prefered integration such as email.
Create your own project on [https://healthchecks.io/](https://healthchecks.io/), and set both the time between pings and the grace time. Set your prefered integration such as email.
Set `healthchecks_enabled: true` in your `inventories/<your_inventory>/nas.yml` file, and if your time between pings is different than the default `healthchecks_ping_minutes`, change it. Finally, set your ping url in the `healthchecks_url` variable.
Set `healthchecks_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file, and if your time between pings is different than the default `healthchecks_ping_minutes`, change it. Finally, set your ping url in the `healthchecks_url` variable.

6
website/docs/applications/system-tools/krusader.md
View file

@ -2,7 +2,7 @@
title: "Krusader"
---
Homepage: <https://krusader.org/>
Homepage: [https://krusader.org/](https://krusader.org/)
Docker Container: [Krusader](https://hub.docker.com/r/djaydev/krusader)
@ -10,6 +10,6 @@ Krusader provides twin panel file management for your ansible-nas via browser an
## Usage
Set `krusader_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `krusader_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Krusader web interface can be found at <http://ansible_nas_host_or_ip:5800>.
The Krusader web interface can be found at [http://ansible_nas_host_or_ip:5800](http://ansible_nas_host_or_ip:5800).

4
website/docs/applications/system-tools/loki.md
View file

@ -2,7 +2,7 @@
title: "Loki"
---
Homepage: <https://grafana.com/oss/loki/>
Homepage: [https://grafana.com/oss/loki/](https://grafana.com/oss/loki/)
Docker Container: [Loki](https://hub.docker.com/r/grafana/loki)
@ -10,7 +10,7 @@ Loki is a log aggregation system designed to store and query logs from all your
## Usage
Set `loki_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `loki_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Loki doesn't have a web interface. To see what it's doing look at the container logs from your Ansible-NAS shell:

6
website/docs/applications/system-tools/minio.md
View file

@ -2,7 +2,7 @@
title: "Minio"
---
Homepage: <https://min.io/>
Homepage: [https://min.io/](https://min.io/)
Docker Container: [Minio](https://hub.docker.com/r/minio/minio)
@ -10,6 +10,6 @@ MinIO is a High Performance Object Storage released under GNU Affero General Pub
## Usage
Set `minio_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `minio_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Minio web interface can be found at <http://ansible_nas_host_or_ip:9009>.
The Minio web interface can be found at [http://ansible_nas_host_or_ip:9009](http://ansible_nas_host_or_ip:9009).

8
website/docs/applications/system-tools/netbootxyz.md
View file

@ -2,9 +2,9 @@
title: "netboot.xyz"
---
Homepage: <https://netboot.xyz/>
Homepage: [https://netboot.xyz/](https://netboot.xyz/)
Docker Container: <https://hub.docker.com/r/linuxserver/netbootxyz>
Docker Container: [https://hub.docker.com/r/linuxserver/netbootxyz](https://hub.docker.com/r/linuxserver/netbootxyz)
netboot.xyz is a way to PXE boot various operating system installers or utilities from one place within the BIOS without the need of having to go retrieve the media to run the tool. [iPXE](https://ipxe.org/) is used to provide a user friendly menu from within the BIOS that lets you easily choose the operating system you want along with any specific types of versions or bootable flags.
@ -12,6 +12,6 @@ You can remote attach the ISO to servers, set it up as a rescue option in Grub,
## Usage
Set `netbootxyz_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `netbootxyz_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The netbooxyz web interface can be found at <http://ansible_nas_host_or_ip:3002>.
The netbooxyz web interface can be found at [http://ansible_nas_host_or_ip:3002](http://ansible_nas_host_or_ip:3002).

6
website/docs/applications/system-tools/portainer.md
View file

@ -2,10 +2,10 @@
title: "Portainer"
---
Homepage: <https://docs.portainer.io/start/install/server/docker>
Homepage: [https://docs.portainer.io/start/install/server/docker](https://docs.portainer.io/start/install/server/docker)
## Usage
Set `portainer_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `portainer_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
The Portainer web interface can be found at <http://ansible_nas_host_or_ip:9000>.
The Portainer web interface can be found at [http://ansible_nas_host_or_ip:9000](http://ansible_nas_host_or_ip:9000).

6
website/docs/applications/system-tools/promtail.md
View file

@ -2,7 +2,7 @@
title: "Promtail"
---
Homepage: <https://grafana.com/docs/loki/latest/clients/promtail/>
Homepage: [https://grafana.com/docs/loki/latest/clients/promtail/](https://grafana.com/docs/loki/latest/clients/promtail/)
Docker image: [Promtail](https://hub.docker.com/r/grafana/promtail)
@ -16,6 +16,6 @@ It primarily:
## Usage
Set `promtail_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `promtail_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
To see what Promtail is doing (and what containers it has discovered for tailing), visit the web interface at at <http://ansible_nas_host_or_ip:9080>.
To see what Promtail is doing (and what containers it has discovered for tailing), visit the web interface at at [http://ansible_nas_host_or_ip:9080](http://ansible_nas_host_or_ip:9080).

8
website/docs/applications/system-tools/route53_ddns.md
View file

@ -2,21 +2,21 @@
title: "AWS Route53 Dynamic DNS Updater"
---
ddns-route53: <https://crazymax.dev/ddns-route53/>
ddns-route53: [https://crazymax.dev/ddns-route53/](https://crazymax.dev/ddns-route53/)
AWS Route53: <https://aws.amazon.com/route53/>
AWS Route53: [https://aws.amazon.com/route53/](https://aws.amazon.com/route53/)
If you want your Ansible-NAS accessible externally then you need a domain name. You will also need to set a wildcard host `A` record to point to your static IP, or enable this container to automatically update AWS Route53 with your dynamic IP address.
## Usage
Set `route53_ddns_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `route53_ddns_enabled: true` in your `inventories/<your_inventory>/group_vars/nas.yml` file.
Set required AWS access credentials from the AWS Console. (See below.)
## Specific Configuration
Make sure you set your domain (if different than the `ansible-nas` default) and access details within your `inventories/<your_inventory>/nas.yml` file.
Make sure you set your domain (if different than the `ansible-nas` default) and access details within your `inventories/<your_inventory>/group_vars/nas.yml` file.
To set up Route53 to work with the service, please review the [Prerequisites](https://crazymax.dev/ddns-route53/usage/prerequisites/) page. In short, you will need to set up a Route53 [Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-working-with.html), an [IAM Policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html), and an [IAM User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) with API credentials.

6
website/docs/applications/system-tools/syncthing.md
View file

@ -2,11 +2,11 @@
title: "Syncthing"
---
Homepage: <https://syncthing.net/>
Homepage: [https://syncthing.net/](https://syncthing.net/)
Github: <https://github.com/syncthing/syncthing>
Github: [https://github.com/syncthing/syncthing](https://github.com/syncthing/syncthing)
Docker: <https://hub.docker.com/r/syncthing/syncthing>
Docker: [https://hub.docker.com/r/syncthing/syncthing](https://hub.docker.com/r/syncthing/syncthing)
Syncthing is a continuous file synchronization program. It synchronizes files
between two or more computers. It strives to fulfill the goals below in summary.

6
website/docs/applications/system-tools/timemachine.md
View file

@ -2,9 +2,9 @@
title: "Time Machine"
---
Apple docs: <https://support.apple.com/en-us/HT201250>
Apple docs: [https://support.apple.com/en-us/HT201250](https://support.apple.com/en-us/HT201250)
Docker image: <https://github.com/awlx/samba-timemachine>
Docker image: [https://github.com/awlx/samba-timemachine](https://github.com/awlx/samba-timemachine)
Time Machine is an application that allows you to backup files from your Mac.
@ -12,7 +12,7 @@ Older versions of Time Machine relied on AFP (netatalk) shares. Apple has deprec
## Usage
Set `timemachine_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `timemachine_enabled: true` in your `inventories/<your_inventory>/group_vars/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.

6
website/docs/applications/system-tools/watchtower.md
View file

@ -2,16 +2,16 @@
title: "Watchtower"
---
Homepage: <https://github.com/v2tec/watchtower>
Homepage: [https://github.com/v2tec/watchtower](https://github.com/v2tec/watchtower)
A process for watching your Docker containers and automatically updating and restarting them whenever their base image is refreshed.
## Usage
Set `watchtower_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
Set `watchtower_enabled: true` in your `inventories/<your_inventory>/group_vars/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 `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).
Various notification options are available, and can be configured by updating `watchtower_command` in your `inventories/<your_inventory>/group_vars/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).

14626
website/package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff