mirror of
https://github.com/davestephens/ansible-nas
synced 2024-11-10 06:04:15 +00:00
📝 Remove docs in preparation to git cp
This commit is contained in:
Anarion
parent
9f3f684d01
commit
d0b6fcbb9f
68 changed files with 0 additions and 1166 deletions
|
|
@ -1,21 +0,0 @@
|
|||
# Freshrss
|
||||
|
||||
Homepage: <https://freshrss.org/>
|
||||
|
||||
FreshRSS is a self-hosted RSS feed aggregator like Leed or Kriss Feed.
|
||||
|
||||
It is lightweight, easy to work with, powerful, and customizable.
|
||||
|
||||
It is a multi-user application with an anonymous reading mode. It supports custom tags. There is an API for (mobile) clients, and a Command-Line Interface.
|
||||
|
||||
Thanks to the WebSub standard (formerly PubSubHubbub), FreshRSS is able to receive instant push notifications from compatible sources, such as Mastodon, Friendica, WordPress, Blogger, FeedBurner, etc.
|
||||
|
||||
FreshRSS natively supports basic Web scraping, based on XPath, for Web sites not providing any RSS / Atom feed.
|
||||
|
||||
Finally, it supports extensions for further tuning.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `freshrss_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The FreshRSS web interface can be found at <http://ansible_nas_host_or_ip:8089>.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Get_iPlayer
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The get_iplayer web interface can be found at <http://ansible_nas_host_or_ip:8182>.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Gitea
|
||||
|
||||
Homepage: <https://gitea.io/>
|
||||
|
||||
Gitea is a painless self-hosted Git service.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `gitea_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The Gitea web interface can be found at <http://ansible_nas_host_or_ip:3001>.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# GitLab
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
To make GitLab available externally via Traefik set `gitlab_available_externally: true` in your `inventories/<your_inventory>/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.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Glances
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Glances web interface can be found at <http://ansible_nas_host_or_ip:61208>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
Glances can be integrated with InfluxDB and Grafana.
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
# Gotify
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Gotify web interface can be found at <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/>
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
# Guacamole
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
The default username and password is `guacadmin`. Change it!
|
||||
|
||||
## What to connect to?
|
||||
|
||||
You can run a virtual desktop from your Ansible-NAS box, check out the [Virtual Desktop docs](virtual_desktop.md).
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Healthchecks.io
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Heimdall
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Heimdall web interface can be found at <http://ansible_nas_host_or_ip:10080>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
Heimdall defaults to port 10080 - some browsers block this port. Override `heimdall_port_http` to move it somewhere else.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# Home Assistant
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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>.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Homebridge
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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!
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Jackett
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Jackett web interface can be found at <http://ansible_nas_host_or_ip:9117>.
|
||||
|
|
@ -1,65 +0,0 @@
|
|||
# Jellyfin
|
||||
|
||||
Homepage: <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!
|
||||
|
||||
Note that [Plex](https://www.plex.tv/), also included in Ansible-NAS, has a very
|
||||
similar functionality.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `jellyfin_enabled: true` in your `inventories/<your_inventory>/nas.yml` file. There are further
|
||||
parameters you can edit such as `movies_root`, `tv_root` or `music_root` lower down
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
The jellyfin web interface can be found at port 8896 (http) or 8928 (https, if
|
||||
configured) of your NAS.
|
||||
|
||||
By default, Ansible-NAS gives jellyfin read/write access to the folders where your
|
||||
movies, TV shows and music are stored. To change this to read-only, edit the following
|
||||
lines in `all.yml`:
|
||||
|
||||
```yaml
|
||||
jellyfin_movies_permissions: "rw"
|
||||
jellyfin_tv_permissions: "rw"
|
||||
jellyfin_books_permissions: "rw"
|
||||
jellyfin_audiobooks_permissions: "rw"
|
||||
jellyfin_music_permissions: "rw"
|
||||
```
|
||||
|
||||
so that they end in `ro` instead of `rw`. Note that jellyfin will not be able to
|
||||
delete files then, which might be exactly what you want. However, you will not
|
||||
have the option to store cover art in the related folders. Always leave the
|
||||
configuration directory read/write
|
||||
|
||||
## Naming movies and TV shows
|
||||
|
||||
jellyfin is very fussy about how movies and TV shows must be named to enable
|
||||
automatic downloads of cover art and metadata. In short, movie files should
|
||||
follow how movies are listed in the [IMDb](https://www.imdb.com/), including the
|
||||
year of publication:
|
||||
|
||||
```raw
|
||||
movies/Bride of Frankenstein (1935).mp4
|
||||
```
|
||||
|
||||
Note the spaces. You should probably remove colons and other special characters
|
||||
TV shows require a folder structure with the name of the series - again if
|
||||
possible with the year of publication - followed by sub-folders for the
|
||||
individual seasons. For example, the first episode of the first season of
|
||||
the original "Doctor Who" could be stored as:
|
||||
|
||||
```raw
|
||||
tv/Doctor Who (1963)/Season 1/Doctor Who - s01e01.mp4
|
||||
```
|
||||
|
||||
The [TVDB](https://www.thetvdb.com/) is one source for the exact names of TV
|
||||
shows.
|
||||
|
||||
Unfortunately, there are number of special cases, especially related to split
|
||||
movies and older series. See the [movie
|
||||
naming](https://github.com/MediaBrowser/Wiki/wiki/Movie%20naming) and [TV
|
||||
naming](https://github.com/MediaBrowser/Wiki/wiki/TV-naming) guides for further
|
||||
information.
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
# Joomla
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
- Set `joomla_database_password` in your `all.yml` before installing Joomla.
|
||||
|
||||
- On first run you'll need to enter database details:
|
||||
- Host: `mysql`
|
||||
- Database: `joomla`
|
||||
- Username: `root`
|
||||
- Password: whatever you set for `joomla_database_password`.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# Komga
|
||||
|
||||
Homepage: <https://komga.org/>
|
||||
|
||||
Docker Image: <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.
|
||||
|
||||
Access the webui at <http://ansible_nas_host_or_ip:8088> by default.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# Krusader
|
||||
|
||||
Homepage: <https://krusader.org/>
|
||||
|
||||
Docker Container: [Krusader](https://hub.docker.com/r/djaydev/krusader)
|
||||
|
||||
Krusader provides twin panel file management for your ansible-nas via browser and VNC.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `krusader_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The Krusader web interface can be found at <http://ansible_nas_host_or_ip:5800>.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
# Lidarr
|
||||
|
||||
Homepage: <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.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Mealie
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Mealie web interface can be found at <http://ansible_nas_host_or_ip:9925>.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# Minecraft Server
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Ansible NAS host or ip address should then be usable as a server within the Minecraft multiplayer game menu.
|
||||
|
||||
The image `itzg/minecraft-server` has [documentation](https://github.com/itzg/docker-minecraft-server/blob/master/README.md) with further details on how to manage the Minecraft server instance.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# MiniDLNA
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The very basic MiniDLNA web interface can be found at <http://ansible_nas_host_or_ip:8201>.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Miniflux
|
||||
|
||||
Homepage: <https://miniflux.app/>
|
||||
|
||||
Miniflux is a minimalist and opinionated feed reader.
|
||||
|
||||
## Usage
|
||||
|
||||
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`.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
An admin user will be created with the username and password of `miniflux_admin_username` and `miniflux_admin_password` respectively. These can be found in the Miniflux section within `all.yml.dist`.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
# Mosquitto
|
||||
|
||||
Homepage: <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.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Mylar
|
||||
|
||||
Homepage: <https://github.com/evilhero/mylar>
|
||||
|
||||
Docker Container: <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.
|
||||
|
||||
If you want to access Mylar externally, don't forget to set `mylar_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The Mylar web interface can be found at <http://ansible_nas_host_or_ip:5858>.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# My Media for Alexa
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The My Media for Alexa web interface can be found at <http://ansible_nas_host_or_ip:52051>.
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
# Nodemation (n8n)
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
n8n is secured by default, he user and password can be set with:
|
||||
|
||||
```yaml
|
||||
n8n_basic_auth_user: "<user name>"
|
||||
n8n_basic_auth_password: "<user password>"
|
||||
```
|
||||
|
||||
The default for these is "n8n_user" and "n8n_change_me" respectively, it is recommended to change these.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Navidrome
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Navidrome web interface can be found at <http://ansible_nas_host_or_ip:4533>.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# netboot.xyz
|
||||
|
||||
Homepage: <https://netboot.xyz/>
|
||||
|
||||
Docker Container: <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.
|
||||
|
||||
You can remote attach the ISO to servers, set it up as a rescue option in Grub, or even set up your home network to boot to it by default so that it's always available.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `netbootxyz_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The netbooxyz web interface can be found at <http://ansible_nas_host_or_ip:3002>.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Netdata
|
||||
|
||||
Homepage: <https://www.netdata.cloud/open-source/>
|
||||
|
||||
An extremely comprehensive system monitoring solution.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `netdata_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
Netdata web interface can be found at <http://ansible_nas_host_or_ip:19999>.
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Nextcloud
|
||||
|
||||
Homepage: <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 environment variable set up for this in the "nextcloud task" which will most likely make manual configuration unnecessary. 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.
|
||||
|
||||
This can be accomplished in two commands.
|
||||
|
||||
```bash
|
||||
# On the server where the docker containers are running
|
||||
$ docker exec -it --user www-data nextcloud /bin/bash
|
||||
$ php occ config:system:set trusted_domains INDEX_FOR_NEW_ENTRY_SEE_DOCS_LINK_BELOW --value=YOUR_FQDN_HERE --update-only
|
||||
```
|
||||
|
||||
The above commands are documented in the administration guide for Nextcloud:
|
||||
|
||||
* [set array values](https://docs.nextcloud.com/server/14/admin_manual/configuration_server/occ_command.html#setting-an-array-configuration-value)
|
||||
|
||||
* [docker container docs, references environment variables](https://github.com/nextcloud/docker)
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Nomad
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
Nomad's web interface can be found at <http://ansible_nas_host_or_ip:4646>
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# NZBGet
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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!
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Octoprint
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
# Ombi
|
||||
|
||||
Homepage: <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.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# openHAB
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
The openHAB Webinterface is available at port 7777 (HTTP) and 7778 (HTTPS).
|
||||
Visit the webinterface and follow the setup instructions found in the [openHAB Documentation](https://www.openhab.org/docs/tutorial/1sttimesetup.html)
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Organizr
|
||||
|
||||
Homepage: <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
|
||||
|
||||
## Usage
|
||||
|
||||
Set `organizr_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The Organizr web interface can be found at <http://ansible_nas_host_or_ip:10081>.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# Overseerr
|
||||
|
||||
Homepage: <https://docs.overseerr.dev>
|
||||
|
||||
Docker Container: <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.
|
||||
|
||||
The overseerr web interface can be found at <http://ansible_nas_host_or_ip:5055>.
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
# Paperless-ng
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
Paperless-ng is a fork of the original project, adding a new interface and many other changes under the hood
|
||||
|
||||
## Usage
|
||||
|
||||
Set `paperless_ng_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The paperless-ng web interface can be found at <http://ansible_nas_host_or_ip:16922>.
|
||||
|
||||
### Create the superuser
|
||||
|
||||
To be able to login, you will need a super user. To create it, execute the following command:
|
||||
|
||||
```bash
|
||||
docker exec -it paperless_ng_uiserver python manage.py createsuperuser
|
||||
```
|
||||
|
||||
This will prompt you to set a username, an optional e-mail address and finally a password (at least 8 characters).
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
# Piwigo
|
||||
|
||||
Homepage: [Piwigo.org](https://piwigo.org)
|
||||
|
||||
Piwigo is open source photo gallery software for the web. Designed for organisations, teams and individuals.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `piwigo_enabled: 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>/nas.yml` file.
|
||||
|
||||
The Piwigo web interface can be found at <http://ansible_nas_host_or_ip:16923>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
Optional configurations:
|
||||
|
||||
- Set `piwigo_mysql_user` in `inventories/<your_inventory>/group_vars/nas.yml` before installing Piwigo, this defaults to "piwigo".
|
||||
- Set `piwigo_mysql_password` in `inventories/<your_inventory>/group_vars/nas.yml` before installing Piwigo, this defaults to "piwigo".
|
||||
- Set `piwigo_mysql_root_password` in `inventories/<your_inventory>/group_vars/nas.yml` before installing Piwigo, this defaults to "piwigo".
|
||||
|
||||
- On first run you'll need to enter database details:
|
||||
- Host: `db:3306`
|
||||
- Username: the value of piwigo_mysql_user, defaults to "piwigo"
|
||||
- Password: the value of piwigo_password, defaults to "piwigo"
|
||||
- Database Name: `piwigo`
|
||||
- Database tables prefix: should be prefilled with `piwigo_`
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
# Plex
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Plex web interface can be found at <http://ansible_nas_host_or_ip:32400/web/index.html>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
You'll need to log in with a plex account, (or possibly claim your server).
|
||||
You'll need to set up your local file store - go to settings > Manage > Libraries, and add your libraries. These are mounted in the root directory by default.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
# Portainer
|
||||
|
||||
Homepage: <https://docs.portainer.io/start/install/server/docker>
|
||||
|
||||
## Usage
|
||||
|
||||
Set `portainer_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The Portainer web interface can be found at <http://ansible_nas_host_or_ip:9000>.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Prowlarr"
|
||||
|
||||
Homepages: [prowlarr](https://github.com/Prowlarr/Prowlarr)
|
||||
|
||||
**Prowlarr** is a indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Sonarr, Radarr, Lidarr, and Readarr offering complete management of your indexers with no per app Indexer setup required (we do it all).
|
||||
|
||||
## Usage
|
||||
|
||||
Set `prowlarr_enabled: true` in your `/inventories/[my inventory]/group_vars/nas.yml` file.
|
||||
|
||||
The Prowlarr web interface can be found at `http://ansible_nas_host_or_ip:9696` by default
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
For comprehensive configuration instructions see the [Prowlarr wiki](https://wiki.servarr.com/prowlarr) or [Prowlarr Github page](https://github.com/Prowlarr/Prowlarr)
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
# pyLoad
|
||||
|
||||
Homepage: [https://pyload.net/](https://pyload.net/)
|
||||
|
||||
Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web.
|
||||
|
||||
## Usage
|
||||
|
||||
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>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
Default username is `pyload` and default password is `pyload`
|
||||
In order to add or remove users, you will need to access the container from an interactive shell (can easily be done from portainer, if installed) and enter pyLoad's home directory `/opt/pyload` and using the command `python pyLoadCore.py -u` and follow the on-screen prompts. More commands to configure and customize pyLoad can be found on it's website.
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
# PyTivo
|
||||
|
||||
Project Homepage:
|
||||
<https://github.com/lucasnz/pytivo>
|
||||
|
||||
Docker Homepage:
|
||||
<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/>
|
||||
|
||||
## 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>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
PyTivo needs to be configured for use. Your ansible-nas media is
|
||||
available to share via:
|
||||
|
||||
* /movies - Where your movies are stored
|
||||
* /music - Where your music is stored
|
||||
* /photos - Where your photos are stored
|
||||
* /podcasts - Where your podcasts are stored
|
||||
* /tv - Where your TV episodes are stored
|
||||
|
||||
Configuration help for PyTivo settings can be found at [Configure_pyTivo](https://pytivo.sourceforge.io/wiki/index.php/Configure_pyTivo).
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
# Radarr
|
||||
|
||||
Homepage: [radarr](https://radarr.video/)
|
||||
|
||||
**Radarr** is an independent fork of Sonarr reworked for automatically downloading movies via Usenet and BitTorrent.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `radarr_enabled: true` in your `/inventories/[my inventory]/group_vars/nas.yml` file.
|
||||
|
||||
The Radarr web interface can be found at `http://ansible_nas_host_or_ip:7878` by default
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
**First make sure Radarr has permissions to write and read the `/download`, and `/movies` folders**. Do this by ensuring the `radarr_movies_directory:` and `radarr_download_directory` settings are correct.
|
||||
|
||||
Radarr will get the file path from the Download client. On default settings with Transmission the path is `/storage/downloads/complete`. You will need to create a path mapping in the **Remote Path Mappings** settings under **Download Client** to point to your internal path that is by default `/downloads`. *If you have difficulties with the path mapping you could also just add a new volume path for the Transmission container and use `/downloads` as the download directory.*
|
||||
|
||||
For Radarr to understand that the `/movies` folder is a folder, you'll need to add a new subfolder into it.
|
||||
You can also do this by adding a random movie to the folder. Keep in mind to have the internal setting **Create empty movie folders** on **yes**
|
||||
|
||||
Comprehensive setup information can be found on the [Radarr GitHub wiki](https://github.com/Radarr/Radarr/wiki/Setup-Guide)
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
# AWS Route53 Dynamic DNS Updater
|
||||
|
||||
ddns-route53: <https://crazymax.dev/ddns-route53/>
|
||||
|
||||
AWS 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 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.
|
||||
|
||||
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.
|
||||
|
||||
### AWS Access Credentials
|
||||
|
||||
| Parameter | Description | Status |
|
||||
|--------------------|-------------------|-----------|
|
||||
| route53_key_id | AWS access key ID | mandatory |
|
||||
| route53_secret_key | AWS secret key | mandatory |
|
||||
|
||||
### Networking
|
||||
|
||||
| Parameter | Description | Status |
|
||||
|------------------------|--------------------------------|-----------|
|
||||
| route53_hosted_zone_id | Route53 hosted zone ID | mandatory |
|
||||
| route53_ttl | Time-to-live for the DNS entry | |
|
||||
| route53_host | Wildcard domain to update | |
|
||||
|
||||
### Application
|
||||
|
||||
| Parameter | Description | Status |
|
||||
|------------------|-----------------------------------------------------|-----------|
|
||||
| route53_schedule | [CRON](https://pkg.go.dev/github.com/robfig/cron?utm_source=godoc#hdr-CRON_Expression_Format) schedule for checking and updating DNS entry | |
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# RSS-Bridge
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
Important: RSS-Bridge is not a feed reader or feed aggregator, but a tool to generate feeds that are consumed by feed readers and feed aggregators.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `rssbridge_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The RSS-Bridge web interface can be found at <http://ansible_nas_host_or_ip:8091>.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Sabnzbd
|
||||
|
||||
Homepage: <https://sabnzbd.org/>
|
||||
|
||||
The time tested Usenet downloader provided with FreeNAS. It just works for those migrating from FreeNAS.
|
||||
|
||||
## Usage
|
||||
|
||||
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.
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
# 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
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
# Sonarr
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `sonarr_enabled: true` in your `/inventories/[my inventory]/group_vars/nas.yml` file.
|
||||
|
||||
The Sonarr web interface can be found at `http://ansible_nas_host_or_ip:8989` by default
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
**First make sure Sonarr has permissions to write and read the `/download` and `/tv` folders**. Do this by ensuring the `sonarr_movies_directory:` and `sonarr_download_directory` settings are correct.
|
||||
|
||||
Sonarr will get the file path from the Download client. On default settings with Transmission the path is `/storage/downloads/complete`. You will need to create a path mapping in the **Remote Path Mappings** settings under **Download Client** to point to your internal path that is by default `/downloads`. *If you have difficulties with the path mapping you could also just add a new volume path for the Transmission container and use `/downloads` as the download directory.*
|
||||
|
||||
For Sonarr to understand that the `/tv` folder is a folder, you'll need to add a folder into it.
|
||||
You can also do this by adding a random series to the folder. Keep in mind to have the setting **Create empty movie folders** on **yes**
|
||||
|
||||
For comprehensive configuration instructions see the [Sonarr GitHub wiki](https://github.com/Sonarr/Sonarr/wiki)
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Speedtest-Tracker
|
||||
|
||||
Homepage: <https://github.com/henrywhitaker3/Speedtest-Tracker>
|
||||
|
||||
Docker Container: <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.
|
||||
|
||||
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.
|
||||
|
||||
The Speedtest-Tracker interface can be found at <http://ansible_nas_host_or_ip:8765>.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# Stats
|
||||
|
||||
The stats role uses Prometheus, Grafana, Telegraf and a number of metrics exporters to collect and record lots of metrics about your NAS.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
# Syncthing
|
||||
|
||||
Homepage: <https://syncthing.net/>
|
||||
|
||||
Github: <https://github.com/syncthing/syncthing>
|
||||
|
||||
Docker: <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.
|
||||
Syncthing should be:
|
||||
|
||||
1. Safe From Data Loss
|
||||
2. Secure Against Attackers
|
||||
3. Easy to Use
|
||||
4. Automatic
|
||||
5. Universally Available
|
||||
6. For Individuals
|
||||
7. For eveything else see the goals document
|
||||
|
||||
## Usage
|
||||
|
||||
Set `syncthing_enabled: true` in your `\inventories\[my inventory]\group_vars\nas.yml` file.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
Open the web interface at :8384 to configure.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Tautulli
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Tautulli web interface can be found at <http://ansible_nas_host_or_ip:8181>.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# The Lounge"
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Lounge web interface can be found at <http://ansible_nas_host_or_ip:9000>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
The default username and password is `admin`. Change this once you've logged in!
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
# TiddlyWiki
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
If you want to access TiddlyWiki externally, set `tiddlywiki_available_externally: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
The TiddlyWiki web interface can be found at <http://ansible_nas_host_or_ip:8092>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
The TiddlyWiki role has several configuration parameters. All parameters are optional.
|
||||
|
||||
### Data and Networking
|
||||
|
||||
| Parameter | Description |
|
||||
|---------------------------|-------------------------------|
|
||||
| tiddlywiki_data_directory | Host location to store data |
|
||||
| tiddlywiki_port | Host port for internal access |
|
||||
| tiddlywiki_hostname | Subdomain for external access |
|
||||
|
||||
### Server Configuration
|
||||
|
||||
| Parameter | Description |
|
||||
|------------------------|--------------------------|
|
||||
| tiddlywiki_username | Basic Auth username |
|
||||
| tiddlywiki_password | Basic Auth password |
|
||||
| tiddlywiki_node_memory | NodeJS memory allocation |
|
||||
| tiddlywiki_debug_level | Service debugging |
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
# Time Machine
|
||||
|
||||
Apple docs: <https://support.apple.com/en-us/HT201250>
|
||||
|
||||
Docker image: <https://github.com/awlx/samba-timemachine>
|
||||
|
||||
Time Machine is an application that allows you to backup files from your Mac.
|
||||
|
||||
Older versions of Time Machine relied on AFP (netatalk) shares. Apple has deprecated Time Machine over AFP in favor of SMB (Samba), and current versions of Ansible-NAS use a Samba-based Time Machine share. If you are upgrading from an older version of Ansible-NAS, you will need to re-select your Time Machine back up disk by opening Time Machine Preferences and Selecting your backup disk via the "Select Disk..." option. Your Mac will find the old backups on the share and use them.
|
||||
|
||||
## Usage
|
||||
|
||||
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.
|
||||
|
||||
The Samba server included in the Time Machine docker container logs to `STDOUT` and is compatible with [Docker's built-in logging infrastructure.](https://docs.docker.com/config/containers/logging/)
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
- `timemachine_data_directory`: The absolute path on Ansible NAS where the backup files will be stored
|
||||
- `timemachine_volume_size_limit`: The maximum amount of space Time Machine can use for the backups in units of MiB. Set it to 0 for no limit.
|
||||
- `timemachine_share_name`: The name of the share as it will appear in the Time Machine application. Default is 'Data'
|
||||
- `timemachine_password`: The password used to access the share. Default is 'timemachine'
|
||||
|
||||
## Upgrading from AFP to SMB-based Time Machine
|
||||
|
||||
Older versions of Time Machine included in Ansible-NAS relied on AFP (netatalk) shares. Apple has deprecated Time Machine over AFP in favor of SMB (Samba), and current versions of Ansible-NAS use a Samba-based Time Machine share. If you are upgrading from an older version of Ansible-NAS with the AFP-based Time Machine, you will need to re-select your Time Machine back up disk by opening Time Machine Preferences and Selecting your backup disk via the "Select Disk..." option. Your Mac will find the old backups on the share and use them.
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
# Traefik
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
You can configure which applications are available externally by enabling the `<application_name>_available_externally` setting
|
||||
for each application in the Advanced Settings section of your `all.yml`.
|
||||
|
||||
See [External Access](../../getting-started/external-access.md) for more info.
|
||||
|
||||
## Usage
|
||||
|
||||
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>.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
You'll need to map port 80 and 443 from your router to your Ansible-NAS box. A quick search should reveal instruction for your model of router.
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Transmission
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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).
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
If you enable Transmission with OpenVPN, you'll need to add the following to your inventory `all.yml`:
|
||||
|
||||
```yaml
|
||||
openvpn_username: super_secret_username
|
||||
openvpn_password: super_secret_password
|
||||
openvpn_provider: NORDVPN
|
||||
openvpn_config: uk686.nordvpn.com.udp
|
||||
```
|
||||
|
||||
See <https://hub.docker.com/r/haugene/transmission-openvpn/> for supported VPN providers.
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Transmission
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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).
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
If you enable Transmission with OpenVPN, you'll need to add the following to your inventory `all.yml`:
|
||||
|
||||
```yaml
|
||||
openvpn_username: super_secret_username
|
||||
openvpn_password: super_secret_password
|
||||
openvpn_provider: NORDVPN
|
||||
openvpn_config: uk686.nordvpn.com.udp
|
||||
```
|
||||
|
||||
See <https://hub.docker.com/r/haugene/transmission-openvpn/> for supported VPN providers.
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Ubooquity
|
||||
|
||||
Homepage: <https://vaemendis.net/ubooquity/>
|
||||
|
||||
Documentation: <https://vaemendis.github.io/ubooquity-doc/>
|
||||
|
||||
Docker Image: <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.
|
||||
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
### 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.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# uTorrent
|
||||
|
||||
Homepage: <https://www.utorrent.com/>
|
||||
Docker Container: <https://hub.docker.com/r/ekho/utorrent>
|
||||
|
||||
## Usage
|
||||
|
||||
Set `utorrent_enabled: 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>/nas.yml` file.
|
||||
|
||||
The uTorrent web interface can be found at <http://ansible_nas_host_or_ip:8111/gui>:
|
||||
|
||||
- Username: admin
|
||||
- Password: *leave blank*
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
# Virtual Desktop
|
||||
|
||||
It's possible to run a cut down desktop within a Docker container. We use [RattyDAVE's custom Ubuntu Mate image](https://github.com/RattyDAVE/docker-ubuntu-xrdp-mate-custom).
|
||||
|
||||
## Usage
|
||||
|
||||
Set `virtual_desktop_enabled: true` in your `inventories/<your_inventory>/nas.yml` file.
|
||||
|
||||
## Specific Configuration
|
||||
|
||||
By default `ansible_nas_user` will be granted access with a password of `topsecret` with sudo rights. To change or add additional users override `vd_users` in your `nas.yml`:
|
||||
|
||||
```yaml
|
||||
vd_users:
|
||||
- username: "{{ ansible_nas_user }}"
|
||||
password: "topsecret"
|
||||
sudo: "Y"
|
||||
- username: "larrylaffer"
|
||||
password: "kensentme"
|
||||
sudo: "Y"
|
||||
```
|
||||
|
||||
## Mounts
|
||||
|
||||
`samba_shares_root` is mounted to `/samba`.
|
||||
`docker_home` is mounted to `/docker`.
|
||||
|
||||
## Remote Access
|
||||
|
||||
It's possible to access your virtual desktop through a web browser! Check out [Guacamole](guacamole.md).
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
# Wallabag
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
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 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>.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Watchtower
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
## 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).
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Wireshark
|
||||
|
||||
Homepage: <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.
|
||||
|
||||
The Wireshark web interface can be found at <http://ansible_nas_host_or_ip:3000>.
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
# Woodpecker CI
|
||||
|
||||
Woodpecker is a simple CI engine with great extensibility.
|
||||
|
||||
Check it out at <https://woodpecker-ci.org/>.
|
||||
|
||||
## Usage
|
||||
|
||||
Set `woodpecker_ci_enabled: true` in your `inventories/<your_inventory>/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.
|
||||
|
||||
Set `woodpecker_ci_admin_user` to the same username as your user in Gitea.
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
# YouTubeDL-Material
|
||||
|
||||
Homepage: <https://github.com/Tzahi12345/YoutubeDL-Material>
|
||||
Docker Container: <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.
|
||||
|
||||
The YouTubeDL-Material web interface can be found at <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.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Znc
|
||||
|
||||
Homepage: <https://wiki.znc.in/ZNC>
|
||||
|
||||
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/<your_inventory>/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.
|
||||
Loading…
Reference in a new issue