Skip to content

Commit

Permalink
Update docs for mdx v3, other minor doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
davestephens committed Dec 30, 2023
1 parent 06e2072 commit 732446f
Show file tree
Hide file tree
Showing 89 changed files with 14,894 additions and 272 deletions.
2 changes: 1 addition & 1 deletion website/blog/2022-09-19-welcome/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions website/docs/applications/content-management/dokuwiki.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 4 additions & 4 deletions website/docs/applications/content-management/joomla.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions website/docs/applications/content-management/tiddlywiki.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions website/docs/applications/dashboards/dashy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
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.
All the code is free and open source, and everything is thoroughly documented, you can get support with any questions on GitHub.

## 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 changes: 3 additions & 3 deletions website/docs/applications/dashboards/heimdall.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 4 additions & 8 deletions website/docs/applications/dashboards/organizr.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check failure on line 7 in website/docs/applications/dashboards/organizr.md

View workflow job for this annotation

GitHub Actions / Lint Docs

Trailing spaces [Expected: 0 or 2; Actual: 1]

## 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 changes: 4 additions & 4 deletions website/docs/applications/development-tools/code-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions website/docs/applications/development-tools/drone_ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions website/docs/applications/development-tools/gitea.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions website/docs/applications/development-tools/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions website/docs/applications/development-tools/nomad.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions website/docs/applications/development-tools/woodpecker_ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 2 additions & 2 deletions website/docs/applications/download-tools/bazarr.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions website/docs/applications/download-tools/couchpotato.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 4 additions & 4 deletions website/docs/applications/download-tools/deluge.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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 changes: 3 additions & 3 deletions website/docs/applications/download-tools/get_iplayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions website/docs/applications/download-tools/jackett.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 2 additions & 2 deletions website/docs/applications/download-tools/lidarr.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 5 additions & 5 deletions website/docs/applications/download-tools/mylar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions website/docs/applications/download-tools/nzbget.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 2 additions & 2 deletions website/docs/applications/download-tools/ombi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading

0 comments on commit 732446f

Please sign in to comment.