From 03dd57a4cf96af071fdf33bd80cc4d0a7039a0ac Mon Sep 17 00:00:00 2001 From: owine Date: Sat, 12 Jul 2025 15:45:16 -0500 Subject: [PATCH 01/16] Rename files to kebab-case for consistency MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - FAQ: Backup and Restore.md → backup-and-restore.md - FAQ: Cloud Storage.md → cloud-storage.md - Saltbox: accessing_apps.md → accessing-apps.md - Saltbox: install_types.md → install-types.md - Apps: hetzner_nfs.md → hetzner-nfs.md - Update mkdocs.yml navigation references --- docs/apps/{hetzner_nfs.md => hetzner-nfs.md} | 0 .../{Backup and Restore.md => backup-and-restore.md} | 0 docs/faq/{Cloud Storage.md => cloud-storage.md} | 0 .../basics/{accessing_apps.md => accessing-apps.md} | 0 .../basics/{install_types.md => install-types.md} | 0 mkdocs.yml | 12 ++++++------ 6 files changed, 6 insertions(+), 6 deletions(-) rename docs/apps/{hetzner_nfs.md => hetzner-nfs.md} (100%) rename docs/faq/{Backup and Restore.md => backup-and-restore.md} (100%) rename docs/faq/{Cloud Storage.md => cloud-storage.md} (100%) rename docs/saltbox/basics/{accessing_apps.md => accessing-apps.md} (100%) rename docs/saltbox/basics/{install_types.md => install-types.md} (100%) diff --git a/docs/apps/hetzner_nfs.md b/docs/apps/hetzner-nfs.md similarity index 100% rename from docs/apps/hetzner_nfs.md rename to docs/apps/hetzner-nfs.md diff --git a/docs/faq/Backup and Restore.md b/docs/faq/backup-and-restore.md similarity index 100% rename from docs/faq/Backup and Restore.md rename to docs/faq/backup-and-restore.md diff --git a/docs/faq/Cloud Storage.md b/docs/faq/cloud-storage.md similarity index 100% rename from docs/faq/Cloud Storage.md rename to docs/faq/cloud-storage.md diff --git a/docs/saltbox/basics/accessing_apps.md b/docs/saltbox/basics/accessing-apps.md similarity index 100% rename from docs/saltbox/basics/accessing_apps.md rename to docs/saltbox/basics/accessing-apps.md diff --git a/docs/saltbox/basics/install_types.md b/docs/saltbox/basics/install-types.md similarity index 100% rename from docs/saltbox/basics/install_types.md rename to docs/saltbox/basics/install-types.md diff --git a/mkdocs.yml b/mkdocs.yml index ed49b969f..ee7790da3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -147,11 +147,11 @@ nav: - Saltbox: - Basics: saltbox/basics/basics.md - Prerequisites: saltbox/prerequisites/prerequisites.md - - Install Types: saltbox/basics/install_types.md + - Install Types: saltbox/basics/install-types.md - Install: saltbox/install/install.md - After-Install: saltbox/install/after.md - Update: saltbox/basics/update.md - - Accessing Apps: saltbox/basics/accessing_apps.md + - Accessing Apps: saltbox/basics/accessing-apps.md - Paths: saltbox/basics/paths.md - Inventory: saltbox/inventory/index.md - Major Upgrade Guide: @@ -409,7 +409,7 @@ nav: - BTRFS Maintenance: apps/btrfsmaintenance.md - Dozzle: apps/dozzle.md - Gluetun: apps/gluetun.md - - Hetzner NFS: apps/hetzner_nfs.md + - Hetzner NFS: apps/hetzner-nfs.md - Netdata: apps/netdata.md - Transfer: apps/transfer.md - Readarr: apps/readarr.md @@ -429,16 +429,16 @@ nav: - FAQ: - System: faq/System.md - - Cloud Storage: faq/Cloud Storage.md + - Cloud Storage: faq/cloud-storage.md - CloudFlare: faq/Cloudflare.md - Cloudplow: faq/Cloudplow.md - Docker: faq/Docker.md - Hetzner & Google IPv6: faq/Hetzner.md - Install: faq/Install.md - - Backup and Restore: faq/Backup and Restore.md + - Backup and Restore: faq/backup-and-restore.md - Rclone: faq/Rclone.md - Plex: faq/Plex.md - - ruTorrent: faq/ruTorrent.md + - ruTorrent: faq/rutorrent.md - Misc: faq/Misc.md - sb: faq/sb.md - Bazarr: faq/Bazarr.md From 3c3b2196e621df0ac722930d0a501ff3b26c4c9c Mon Sep 17 00:00:00 2001 From: owine Date: Sat, 12 Jul 2025 15:45:44 -0500 Subject: [PATCH 02/16] Add YAML frontmatter to all sandbox apps - Add standardized frontmatter with hide/tags metadata - Include semantic tags for app categorization - 162+ apps now have consistent frontmatter structure - Improves SEO and navigation organization --- docs/sandbox/apps/actualbudget.md | 19 ++++++++++++++----- docs/sandbox/apps/adguardhome.md | 9 +++++++++ docs/sandbox/apps/adminer.md | 9 +++++++++ docs/sandbox/apps/airdcpp.md | 9 +++++++++ docs/sandbox/apps/airsonic.md | 9 +++++++++ docs/sandbox/apps/alternatrr.md | 9 +++++++++ docs/sandbox/apps/alternatrrx.md | 9 +++++++++ docs/sandbox/apps/apprise.md | 9 +++++++++ docs/sandbox/apps/archivebox.md | 9 +++++++++ docs/sandbox/apps/arrx.md | 13 +++++++++++-- docs/sandbox/apps/audiobookshelf.md | 9 +++++++++ docs/sandbox/apps/beets.md | 9 +++++++++ docs/sandbox/apps/booksonic.md | 9 +++++++++ docs/sandbox/apps/bookstack.md | 9 +++++++++ docs/sandbox/apps/calibre-web.md | 9 +++++++++ docs/sandbox/apps/calibre.md | 9 +++++++++ docs/sandbox/apps/changedetection.md | 9 +++++++++ docs/sandbox/apps/cherry.md | 9 +++++++++ docs/sandbox/apps/chrome.md | 11 ++++++++++- docs/sandbox/apps/code-server.md | 9 +++++++++ docs/sandbox/apps/comicstreamer.md | 9 +++++++++ docs/sandbox/apps/dashy.md | 9 +++++++++ docs/sandbox/apps/deemix.md | 9 +++++++++ docs/sandbox/apps/delugevpn.md | 11 ++++++++++- docs/sandbox/apps/discoflix.md | 9 +++++++++ docs/sandbox/apps/dockwatch.md | 9 +++++++++ docs/sandbox/apps/doplarr.md | 9 +++++++++ docs/sandbox/apps/duplicati.md | 9 +++++++++ docs/sandbox/apps/elasticsearch.md | 9 +++++++++ docs/sandbox/apps/embystat.md | 9 +++++++++ docs/sandbox/apps/epms.md | 9 +++++++++ docs/sandbox/apps/esphome.md | 9 +++++++++ docs/sandbox/apps/factorio.md | 9 +++++++++ docs/sandbox/apps/filebot.md | 9 +++++++++ docs/sandbox/apps/filebrowser.md | 9 +++++++++ docs/sandbox/apps/filezilla.md | 9 +++++++++ docs/sandbox/apps/fireflyiii.md | 9 +++++++++ docs/sandbox/apps/fireflyiii_importer.md | 9 +++++++++ docs/sandbox/apps/flaresolverr.md | 9 +++++++++ docs/sandbox/apps/forgejo.md | 9 +++++++++ docs/sandbox/apps/freshrss.md | 9 +++++++++ docs/sandbox/apps/funkwhale.md | 9 +++++++++ docs/sandbox/apps/gaps.md | 9 +++++++++ docs/sandbox/apps/gitea.md | 9 +++++++++ docs/sandbox/apps/glances_web.md | 9 +++++++++ docs/sandbox/apps/goaccess.md | 9 +++++++++ docs/sandbox/apps/goplaxt.md | 9 +++++++++ docs/sandbox/apps/gotenberg.md | 9 +++++++++ docs/sandbox/apps/gotify.md | 9 +++++++++ docs/sandbox/apps/guacamole.md | 9 +++++++++ docs/sandbox/apps/handbrake.md | 9 +++++++++ docs/sandbox/apps/healthchecks.md | 9 +++++++++ docs/sandbox/apps/heimdall.md | 9 +++++++++ docs/sandbox/apps/homarr.md | 9 +++++++++ docs/sandbox/apps/homeassistant.md | 9 +++++++++ docs/sandbox/apps/homebox.md | 9 +++++++++ docs/sandbox/apps/homepage.md | 9 +++++++++ docs/sandbox/apps/immich.md | 13 +++++++++++-- docs/sandbox/apps/influxdb.md | 9 +++++++++ docs/sandbox/apps/influxdb2.md | 9 +++++++++ docs/sandbox/apps/invoiceninja.md | 9 +++++++++ docs/sandbox/apps/jdownloader2.md | 9 +++++++++ docs/sandbox/apps/jellyseerr.md | 9 +++++++++ docs/sandbox/apps/joplin.md | 9 +++++++++ docs/sandbox/apps/karakeep.md | 9 +++++++++ docs/sandbox/apps/kavita.md | 9 +++++++++ docs/sandbox/apps/kcptun-client.md | 9 +++++++++ docs/sandbox/apps/kcptun-server.md | 9 +++++++++ docs/sandbox/apps/kitana.md | 9 +++++++++ docs/sandbox/apps/komga.md | 9 +++++++++ docs/sandbox/apps/krusader.md | 9 +++++++++ docs/sandbox/apps/lazylibrarian.md | 9 +++++++++ docs/sandbox/apps/lgsm.md | 9 +++++++++ docs/sandbox/apps/linkding.md | 11 ++++++++++- docs/sandbox/apps/logarr.md | 9 +++++++++ docs/sandbox/apps/lunasea.md | 9 +++++++++ docs/sandbox/apps/maintainerr.md | 9 +++++++++ docs/sandbox/apps/makemkv.md | 9 +++++++++ docs/sandbox/apps/maybe-finance.md | 9 +++++++++ docs/sandbox/apps/mcrouter.md | 2 +- docs/sandbox/apps/mealie.md | 9 +++++++++ docs/sandbox/apps/medusa.md | 9 +++++++++ docs/sandbox/apps/meilisearch.md | 11 ++++++++++- docs/sandbox/apps/membarr.md | 9 +++++++++ docs/sandbox/apps/miniflux.md | 9 +++++++++ docs/sandbox/apps/mkvtoolnix.md | 9 +++++++++ docs/sandbox/apps/monitorr.md | 9 +++++++++ docs/sandbox/apps/moviematch.md | 9 +++++++++ docs/sandbox/apps/mqtt.md | 9 +++++++++ docs/sandbox/apps/mylar3.md | 9 +++++++++ docs/sandbox/apps/n8n.md | 11 ++++++++++- docs/sandbox/apps/nabarr.md | 9 +++++++++ docs/sandbox/apps/navidrome.md | 9 +++++++++ docs/sandbox/apps/nextcloud.md | 9 +++++++++ docs/sandbox/apps/node-red.md | 9 +++++++++ docs/sandbox/apps/notifiarr.md | 9 +++++++++ docs/sandbox/apps/olivetin.md | 9 +++++++++ docs/sandbox/apps/ombi.md | 9 +++++++++ docs/sandbox/apps/ombix.md | 9 +++++++++ docs/sandbox/apps/paperless-ngx.md | 9 +++++++++ docs/sandbox/apps/pgadmin.md | 9 +++++++++ docs/sandbox/apps/photoprism.md | 9 +++++++++ docs/sandbox/apps/phpmyadmin.md | 9 +++++++++ docs/sandbox/apps/plex-auto-languages.md | 9 +++++++++ docs/sandbox/apps/plex-dupefinder.md | 9 +++++++++ docs/sandbox/apps/plex-patrol.md | 9 +++++++++ docs/sandbox/apps/plex-utills.md | 9 +++++++++ docs/sandbox/apps/privatebin.md | 9 +++++++++ docs/sandbox/apps/puddletag.md | 9 +++++++++ docs/sandbox/apps/pyload.md | 9 +++++++++ docs/sandbox/apps/python-plexlibrary.md | 9 +++++++++ docs/sandbox/apps/qbit-manage.md | 9 +++++++++ docs/sandbox/apps/qbittorrentvpn.md | 9 +++++++++ docs/sandbox/apps/rdtclient.md | 9 +++++++++ docs/sandbox/apps/reposilite.md | 9 +++++++++ docs/sandbox/apps/requestrr.md | 9 +++++++++ docs/sandbox/apps/requestrrx.md | 9 +++++++++ docs/sandbox/apps/resiliosync.md | 9 +++++++++ docs/sandbox/apps/rflood.md | 9 +++++++++ docs/sandbox/apps/rfloodx.md | 9 +++++++++ docs/sandbox/apps/rocketchat.md | 9 +++++++++ docs/sandbox/apps/sabthrottle.md | 9 +++++++++ docs/sandbox/apps/sarotate.md | 9 +++++++++ docs/sandbox/apps/semaphoreui.md | 9 +++++++++ docs/sandbox/apps/speedtest.md | 9 +++++++++ docs/sandbox/apps/sqlitebrowser.md | 9 +++++++++ docs/sandbox/apps/sshwifty.md | 9 +++++++++ docs/sandbox/apps/stash.md | 9 +++++++++ docs/sandbox/apps/syncthing.md | 9 +++++++++ docs/sandbox/apps/tandoor.md | 9 +++++++++ docs/sandbox/apps/tauticord.md | 9 +++++++++ docs/sandbox/apps/tdarr-node.md | 9 +++++++++ docs/sandbox/apps/tdarr.md | 9 +++++++++ docs/sandbox/apps/telegraf.md | 9 +++++++++ docs/sandbox/apps/teslamate.md | 9 +++++++++ docs/sandbox/apps/thelounge.md | 9 +++++++++ docs/sandbox/apps/threadfin.md | 9 +++++++++ docs/sandbox/apps/tika.md | 9 +++++++++ docs/sandbox/apps/tqm.md | 9 +++++++++ docs/sandbox/apps/trackarr.md | 9 +++++++++ docs/sandbox/apps/traefik-robotstxt.md | 9 +++++++++ docs/sandbox/apps/transmission.md | 9 +++++++++ docs/sandbox/apps/transmissionvpn.md | 9 +++++++++ docs/sandbox/apps/transmissionx.md | 9 +++++++++ docs/sandbox/apps/trilium.md | 9 +++++++++ docs/sandbox/apps/tubearchivist.md | 9 +++++++++ docs/sandbox/apps/tvheadend.md | 9 +++++++++ .../sandbox/apps/unifi-network-application.md | 9 +++++++++ docs/sandbox/apps/unmanic.md | 9 +++++++++ docs/sandbox/apps/uptime-kuma.md | 9 +++++++++ docs/sandbox/apps/varken.md | 9 +++++++++ docs/sandbox/apps/vaultwarden.md | 9 +++++++++ docs/sandbox/apps/vnstat.md | 9 +++++++++ docs/sandbox/apps/watchtower.md | 9 +++++++++ docs/sandbox/apps/wikijs.md | 13 +++++++++++-- docs/sandbox/apps/wizarr.md | 9 +++++++++ docs/sandbox/apps/wordpress.md | 9 +++++++++ docs/sandbox/apps/wrapperr.md | 9 +++++++++ docs/sandbox/apps/xbackbone.md | 9 +++++++++ docs/sandbox/apps/xteve.md | 9 +++++++++ docs/sandbox/apps/yacht.md | 9 +++++++++ docs/sandbox/apps/yourspotify.md | 11 ++++++++++- docs/sandbox/apps/znc.md | 9 +++++++++ 163 files changed, 1476 insertions(+), 18 deletions(-) diff --git a/docs/sandbox/apps/actualbudget.md b/docs/sandbox/apps/actualbudget.md index 700220c30..3cfa59e67 100644 --- a/docs/sandbox/apps/actualbudget.md +++ b/docs/sandbox/apps/actualbudget.md @@ -1,5 +1,14 @@ -# **Actual Budget** -## **What is it?** +--- +hide: + - tags +tags: + - actualbudget + - budget + - finance +--- + +# Actual Budget +## What is it? [Actual Budget](https://actualbudget.org/) is a super fast, privacy-focused app for managing your finances. Its heart is the well-proven and much-loved Envelope Budgeting methodology. You own your data and can do whatever you want with it. Featuring multi-device sync, optional end-to-end encryption and so much more. @@ -8,14 +17,14 @@ You own your data and can do whatever you want with it. Featuring multi-device s |-------------|-------------|-------------|-------------| | [:material-home: Project home](https://actualbudget.org){: .header-icons } | [:octicons-link-16: Docs](https://actualbudget.org/docs){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/actualbudget/actual){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/actualbudget/actual-server){: .header-icons }| -## **1. Installation** +## 1. Installation ``sb install sandbox-actualbudget`` -## **2. URL** +## 2. URL To access Actual Budget, visit ``https://actualbudget._yourdomain.com_`` -## **3. Usage** +## 3. Usage **[Documentation: Actual Budget Docs](https://actualbudget.org/docs/)** diff --git a/docs/sandbox/apps/adguardhome.md b/docs/sandbox/apps/adguardhome.md index 8dc99ef1a..e520355d8 100644 --- a/docs/sandbox/apps/adguardhome.md +++ b/docs/sandbox/apps/adguardhome.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - adguard + - dns + - adblock +--- + # AdGuard Home ## What is it? diff --git a/docs/sandbox/apps/adminer.md b/docs/sandbox/apps/adminer.md index d6d928e8e..7ea5f3a8a 100644 --- a/docs/sandbox/apps/adminer.md +++ b/docs/sandbox/apps/adminer.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - adminer + - database + - mysql +--- + # Adminer ## What is it? diff --git a/docs/sandbox/apps/airdcpp.md b/docs/sandbox/apps/airdcpp.md index 79d89999a..52a4e4477 100644 --- a/docs/sandbox/apps/airdcpp.md +++ b/docs/sandbox/apps/airdcpp.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - airdcpp + - p2p + - downloading +--- + # AirDC++ ## What is it? diff --git a/docs/sandbox/apps/airsonic.md b/docs/sandbox/apps/airsonic.md index a82958e95..c89be3c47 100644 --- a/docs/sandbox/apps/airsonic.md +++ b/docs/sandbox/apps/airsonic.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - airsonic + - music + - streaming +--- + # Airsonic ## What is it? diff --git a/docs/sandbox/apps/alternatrr.md b/docs/sandbox/apps/alternatrr.md index 946c0124a..037d82620 100644 --- a/docs/sandbox/apps/alternatrr.md +++ b/docs/sandbox/apps/alternatrr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - alternatrr + - sonarr + - metadata +--- + # alternatrr ## What is it? diff --git a/docs/sandbox/apps/alternatrrx.md b/docs/sandbox/apps/alternatrrx.md index 1bb93f7cc..71049258e 100644 --- a/docs/sandbox/apps/alternatrrx.md +++ b/docs/sandbox/apps/alternatrrx.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - alternatrrx + - media + - download +--- + # alternatrr**X** ## What is it? diff --git a/docs/sandbox/apps/apprise.md b/docs/sandbox/apps/apprise.md index a81876e28..f7807fd61 100644 --- a/docs/sandbox/apps/apprise.md +++ b/docs/sandbox/apps/apprise.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - apprise + - notifications + - alerts +--- + # Apprise ## What is it? diff --git a/docs/sandbox/apps/archivebox.md b/docs/sandbox/apps/archivebox.md index 158de8ef1..4e4fd3c0f 100644 --- a/docs/sandbox/apps/archivebox.md +++ b/docs/sandbox/apps/archivebox.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - archivebox + - archiving + - web +--- + # ArchiveBox ## What is it? diff --git a/docs/sandbox/apps/arrx.md b/docs/sandbox/apps/arrx.md index 3f85df1e9..593ea02d9 100644 --- a/docs/sandbox/apps/arrx.md +++ b/docs/sandbox/apps/arrx.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - arrx + - multiple + - instances +--- + # Multiple container instances (Cloudbox legacy style) Read through this entire page, even if you are only installing one of the apps. @@ -92,7 +101,7 @@ You probably want to overwrite your existing role with this one; that will ensur 2. Run the role as described below. -```bash +```shell sb install cm-bazarrx ``` @@ -175,7 +184,7 @@ Again, the same thing holds for every `arrX` variant discussed here. 1. Run the bazarrx role as a normal Saltbox Sandbox role. - ```bash + ```shell sb install cm-bazarrx ``` diff --git a/docs/sandbox/apps/audiobookshelf.md b/docs/sandbox/apps/audiobookshelf.md index eb0b0db04..2adc05478 100644 --- a/docs/sandbox/apps/audiobookshelf.md +++ b/docs/sandbox/apps/audiobookshelf.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - audiobookshelf + - audiobooks + - podcasts +--- + # Audiobookshelf ## What is it? diff --git a/docs/sandbox/apps/beets.md b/docs/sandbox/apps/beets.md index 0f5002aca..6c2780ee8 100644 --- a/docs/sandbox/apps/beets.md +++ b/docs/sandbox/apps/beets.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - beets + - music + - metadata +--- + # Beets ## What is it? diff --git a/docs/sandbox/apps/booksonic.md b/docs/sandbox/apps/booksonic.md index ee0c921d7..5b4b62a90 100644 --- a/docs/sandbox/apps/booksonic.md +++ b/docs/sandbox/apps/booksonic.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - booksonic + - audiobooks + - streaming +--- + # Booksonic Air !!! warning diff --git a/docs/sandbox/apps/bookstack.md b/docs/sandbox/apps/bookstack.md index e3c0aa302..3585bf081 100644 --- a/docs/sandbox/apps/bookstack.md +++ b/docs/sandbox/apps/bookstack.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - bookstack + - wiki + - documentation +--- + # BookStack ## What is it? diff --git a/docs/sandbox/apps/calibre-web.md b/docs/sandbox/apps/calibre-web.md index 6f558c71b..47db798b9 100644 --- a/docs/sandbox/apps/calibre-web.md +++ b/docs/sandbox/apps/calibre-web.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - calibre + - ebooks + - reading +--- + # Calibre-Web ## What is it? diff --git a/docs/sandbox/apps/calibre.md b/docs/sandbox/apps/calibre.md index 9c6e51cb9..e31fe58a3 100644 --- a/docs/sandbox/apps/calibre.md +++ b/docs/sandbox/apps/calibre.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - calibre + - ebooks + - management +--- + # Calibre ## What is it? diff --git a/docs/sandbox/apps/changedetection.md b/docs/sandbox/apps/changedetection.md index b808020d9..8680a4979 100644 --- a/docs/sandbox/apps/changedetection.md +++ b/docs/sandbox/apps/changedetection.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - changedetection + - monitoring + - websites +--- + # Change Detection ## What is it? diff --git a/docs/sandbox/apps/cherry.md b/docs/sandbox/apps/cherry.md index 91de8788a..71899400e 100644 --- a/docs/sandbox/apps/cherry.md +++ b/docs/sandbox/apps/cherry.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - cherry + - bookmarks + - organization +--- + # Cherry ## What is it? diff --git a/docs/sandbox/apps/chrome.md b/docs/sandbox/apps/chrome.md index 89b2daa0c..9e7d9bb33 100644 --- a/docs/sandbox/apps/chrome.md +++ b/docs/sandbox/apps/chrome.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - chrome + - browser + - headless +--- + # Chrome Headless container running Google Chrome. Useful for testing, filling out forms, web crawling, getting webpage screenshots, etc. @@ -24,7 +33,7 @@ sb install sandbox-chrome The docker commands are set to the following by default. Port 9222 is open to the container by default. -```yml +```yaml - --no-sandbox - --disable-gpu - --disable-dev-shm-usage diff --git a/docs/sandbox/apps/code-server.md b/docs/sandbox/apps/code-server.md index dd9f535b5..e7cc8590e 100644 --- a/docs/sandbox/apps/code-server.md +++ b/docs/sandbox/apps/code-server.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - code-server + - vscode + - development +--- + # code-server ## What is it? diff --git a/docs/sandbox/apps/comicstreamer.md b/docs/sandbox/apps/comicstreamer.md index 5bfdba3a5..434017d8a 100644 --- a/docs/sandbox/apps/comicstreamer.md +++ b/docs/sandbox/apps/comicstreamer.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - comicstreamer + - media + - comics +--- + # ComicStreamer ## What is it? diff --git a/docs/sandbox/apps/dashy.md b/docs/sandbox/apps/dashy.md index 32f408465..e37ff3637 100644 --- a/docs/sandbox/apps/dashy.md +++ b/docs/sandbox/apps/dashy.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - dashy + - dashboard + - homepage +--- + # Dashy ## What is it? diff --git a/docs/sandbox/apps/deemix.md b/docs/sandbox/apps/deemix.md index ef1789626..863957c63 100644 --- a/docs/sandbox/apps/deemix.md +++ b/docs/sandbox/apps/deemix.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - deemix + - media + - music +--- + # deemix ## What is it? diff --git a/docs/sandbox/apps/delugevpn.md b/docs/sandbox/apps/delugevpn.md index eabd030c4..0c310f499 100644 --- a/docs/sandbox/apps/delugevpn.md +++ b/docs/sandbox/apps/delugevpn.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - delugevpn + - download + - vpn +--- + # DelugeVPN ## What is it? @@ -47,7 +56,7 @@ See the parent [Deluge](../../apps/deluge.md) role for app setup. - Leave `vpn_endpoint` as `netherlands.ovpn` - Follow step 2 below then immediately follow step 3 -### **Run the DelugeVPN Role** +### Run the DelugeVPN Role ``` { .shell } diff --git a/docs/sandbox/apps/discoflix.md b/docs/sandbox/apps/discoflix.md index 3a3fa89f2..a2cb928d9 100644 --- a/docs/sandbox/apps/discoflix.md +++ b/docs/sandbox/apps/discoflix.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - discoflix + - requests + - discord +--- + # DiscoFlix ## What is it? diff --git a/docs/sandbox/apps/dockwatch.md b/docs/sandbox/apps/dockwatch.md index 4341d6b07..b269747e5 100644 --- a/docs/sandbox/apps/dockwatch.md +++ b/docs/sandbox/apps/dockwatch.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - dockwatch + - monitoring + - docker +--- + # Dockwatch ## What is it? diff --git a/docs/sandbox/apps/doplarr.md b/docs/sandbox/apps/doplarr.md index c97e4c1e8..35941b0fd 100644 --- a/docs/sandbox/apps/doplarr.md +++ b/docs/sandbox/apps/doplarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - doplarr + - media + - discord +--- + # Doplarr ## What is it? diff --git a/docs/sandbox/apps/duplicati.md b/docs/sandbox/apps/duplicati.md index b63fa0fa9..6fb98d987 100644 --- a/docs/sandbox/apps/duplicati.md +++ b/docs/sandbox/apps/duplicati.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - duplicati + - backup + - sync +--- + # Duplicati ## What is it? diff --git a/docs/sandbox/apps/elasticsearch.md b/docs/sandbox/apps/elasticsearch.md index 90f4e1151..438d4a3d2 100644 --- a/docs/sandbox/apps/elasticsearch.md +++ b/docs/sandbox/apps/elasticsearch.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - elasticsearch + - search + - analytics +--- + # Elasticsearch ## What is it? diff --git a/docs/sandbox/apps/embystat.md b/docs/sandbox/apps/embystat.md index aaddc89e2..11ed78d54 100644 --- a/docs/sandbox/apps/embystat.md +++ b/docs/sandbox/apps/embystat.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - embystat + - statistics + - monitoring +--- + # EmbyStat ## What is it? diff --git a/docs/sandbox/apps/epms.md b/docs/sandbox/apps/epms.md index 0a233c4db..c105cc1a7 100644 --- a/docs/sandbox/apps/epms.md +++ b/docs/sandbox/apps/epms.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - epms + - plex + - metadata +--- + # Extended Personal Media Shows Agent and Scanner ## What is it? diff --git a/docs/sandbox/apps/esphome.md b/docs/sandbox/apps/esphome.md index 90cced987..755ac65f9 100644 --- a/docs/sandbox/apps/esphome.md +++ b/docs/sandbox/apps/esphome.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - esphome + - automation + - iot +--- + # ESPHome ## What is it? diff --git a/docs/sandbox/apps/factorio.md b/docs/sandbox/apps/factorio.md index 16e606efc..b835e5b08 100644 --- a/docs/sandbox/apps/factorio.md +++ b/docs/sandbox/apps/factorio.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - factorio + - gaming + - server +--- + # Factorio ## What is it? diff --git a/docs/sandbox/apps/filebot.md b/docs/sandbox/apps/filebot.md index 5bb2a6800..781e91949 100644 --- a/docs/sandbox/apps/filebot.md +++ b/docs/sandbox/apps/filebot.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - filebot + - media + - tools +--- + # FileBot ## What is it? diff --git a/docs/sandbox/apps/filebrowser.md b/docs/sandbox/apps/filebrowser.md index 4c5dff375..b0f582e83 100644 --- a/docs/sandbox/apps/filebrowser.md +++ b/docs/sandbox/apps/filebrowser.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - filebrowser + - file-management + - admin +--- + # File Browser ## What is it? diff --git a/docs/sandbox/apps/filezilla.md b/docs/sandbox/apps/filezilla.md index 3f6f0af9b..628b05eed 100644 --- a/docs/sandbox/apps/filezilla.md +++ b/docs/sandbox/apps/filezilla.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - filezilla + - file-management + - ftp +--- + # FileZilla ## What is it? diff --git a/docs/sandbox/apps/fireflyiii.md b/docs/sandbox/apps/fireflyiii.md index 30e57fc3e..581263378 100644 --- a/docs/sandbox/apps/fireflyiii.md +++ b/docs/sandbox/apps/fireflyiii.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - fireflyiii + - finance + - budgeting +--- + # Firefly III [TOC] diff --git a/docs/sandbox/apps/fireflyiii_importer.md b/docs/sandbox/apps/fireflyiii_importer.md index 70d5fbc0b..d9749047a 100644 --- a/docs/sandbox/apps/fireflyiii_importer.md +++ b/docs/sandbox/apps/fireflyiii_importer.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - fireflyiii-importer + - finance + - tools +--- + # Firefly III Data Importer [TOC] diff --git a/docs/sandbox/apps/flaresolverr.md b/docs/sandbox/apps/flaresolverr.md index d6efb717c..616a8b01f 100644 --- a/docs/sandbox/apps/flaresolverr.md +++ b/docs/sandbox/apps/flaresolverr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - flaresolverr + - networking + - proxy +--- + # FlareSolverr ## What is it? diff --git a/docs/sandbox/apps/forgejo.md b/docs/sandbox/apps/forgejo.md index 0a3dd8bcf..4a1552f66 100644 --- a/docs/sandbox/apps/forgejo.md +++ b/docs/sandbox/apps/forgejo.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - forgejo + - development + - git +--- + # Forgejo ## What is it? diff --git a/docs/sandbox/apps/freshrss.md b/docs/sandbox/apps/freshrss.md index bd7442d4e..e84b53cef 100644 --- a/docs/sandbox/apps/freshrss.md +++ b/docs/sandbox/apps/freshrss.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - freshrss + - media + - rss +--- + # Freshrss ## What is it? diff --git a/docs/sandbox/apps/funkwhale.md b/docs/sandbox/apps/funkwhale.md index e79afd5e1..2b57189e5 100644 --- a/docs/sandbox/apps/funkwhale.md +++ b/docs/sandbox/apps/funkwhale.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - funkwhale + - media + - music +--- + # Funkwhale ## What is it? diff --git a/docs/sandbox/apps/gaps.md b/docs/sandbox/apps/gaps.md index 1c883b2e7..b7e28f1ec 100644 --- a/docs/sandbox/apps/gaps.md +++ b/docs/sandbox/apps/gaps.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - gaps + - media + - plex +--- + # Gaps ## What is it? diff --git a/docs/sandbox/apps/gitea.md b/docs/sandbox/apps/gitea.md index 402872c2d..d8252f397 100644 --- a/docs/sandbox/apps/gitea.md +++ b/docs/sandbox/apps/gitea.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - gitea + - development + - git +--- + # Gitea ## What is it? diff --git a/docs/sandbox/apps/glances_web.md b/docs/sandbox/apps/glances_web.md index 56a1e3b04..2c66c3ea5 100644 --- a/docs/sandbox/apps/glances_web.md +++ b/docs/sandbox/apps/glances_web.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - glances + - monitoring + - system +--- + # Glances ## What is it? diff --git a/docs/sandbox/apps/goaccess.md b/docs/sandbox/apps/goaccess.md index 7c864c77c..5dda39e98 100644 --- a/docs/sandbox/apps/goaccess.md +++ b/docs/sandbox/apps/goaccess.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - goaccess + - monitoring + - analytics +--- + # GoAccess ## What is it? diff --git a/docs/sandbox/apps/goplaxt.md b/docs/sandbox/apps/goplaxt.md index 730084a80..9b78f429f 100644 --- a/docs/sandbox/apps/goplaxt.md +++ b/docs/sandbox/apps/goplaxt.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - goplaxt + - media + - trakt +--- + # Goplaxt ## What is it? diff --git a/docs/sandbox/apps/gotenberg.md b/docs/sandbox/apps/gotenberg.md index 423c24958..1197d0f9a 100644 --- a/docs/sandbox/apps/gotenberg.md +++ b/docs/sandbox/apps/gotenberg.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - gotenberg + - tools + - pdf +--- + # gotenberg ## THIS DOCUMENTATION IS NOT YET COMPLETED diff --git a/docs/sandbox/apps/gotify.md b/docs/sandbox/apps/gotify.md index dc0a6b7ac..5c62b28d5 100644 --- a/docs/sandbox/apps/gotify.md +++ b/docs/sandbox/apps/gotify.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - gotify + - notifications + - messaging +--- + # Gotify ## What is it? diff --git a/docs/sandbox/apps/guacamole.md b/docs/sandbox/apps/guacamole.md index 4407be253..0460f2c2c 100644 --- a/docs/sandbox/apps/guacamole.md +++ b/docs/sandbox/apps/guacamole.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - guacamole + - networking + - remote-access +--- + # Guacamole ## What is it? diff --git a/docs/sandbox/apps/handbrake.md b/docs/sandbox/apps/handbrake.md index 1c23aefd9..df525e343 100644 --- a/docs/sandbox/apps/handbrake.md +++ b/docs/sandbox/apps/handbrake.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - handbrake + - media + - encoding +--- + # HandBrake ## What is it? diff --git a/docs/sandbox/apps/healthchecks.md b/docs/sandbox/apps/healthchecks.md index 2c74749f2..5341d8d2b 100644 --- a/docs/sandbox/apps/healthchecks.md +++ b/docs/sandbox/apps/healthchecks.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - healthchecks + - monitoring + - cron +--- + # Healthchecks ## What is it? diff --git a/docs/sandbox/apps/heimdall.md b/docs/sandbox/apps/heimdall.md index e3c10df23..975b669b1 100644 --- a/docs/sandbox/apps/heimdall.md +++ b/docs/sandbox/apps/heimdall.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - heimdall + - dashboard + - homepage +--- + # Heimdall ## What is it? diff --git a/docs/sandbox/apps/homarr.md b/docs/sandbox/apps/homarr.md index d32ff977a..a2f1b9390 100644 --- a/docs/sandbox/apps/homarr.md +++ b/docs/sandbox/apps/homarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - homarr + - dashboard + - homepage +--- + # Homarr ## What is it? diff --git a/docs/sandbox/apps/homeassistant.md b/docs/sandbox/apps/homeassistant.md index 395af2212..c8236f2ad 100644 --- a/docs/sandbox/apps/homeassistant.md +++ b/docs/sandbox/apps/homeassistant.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - homeassistant + - automation + - iot +--- + # Homeassistant ## What is it? diff --git a/docs/sandbox/apps/homebox.md b/docs/sandbox/apps/homebox.md index 43ee8214b..dc23b6d80 100644 --- a/docs/sandbox/apps/homebox.md +++ b/docs/sandbox/apps/homebox.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - homebox + - productivity + - inventory +--- + # Homebox ## What is it? diff --git a/docs/sandbox/apps/homepage.md b/docs/sandbox/apps/homepage.md index 06057753c..abe2eaf7c 100644 --- a/docs/sandbox/apps/homepage.md +++ b/docs/sandbox/apps/homepage.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - homepage + - dashboard + - static +--- + # Homepage ## What is it? diff --git a/docs/sandbox/apps/immich.md b/docs/sandbox/apps/immich.md index 4aaaede6d..1a72ae3f0 100644 --- a/docs/sandbox/apps/immich.md +++ b/docs/sandbox/apps/immich.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - immich + - photos + - backup +--- + # Immich ## What is it? @@ -17,7 +26,7 @@ - Smart Search - XMP Sidecars -!!!info +!!! info By default, Immich is NOT protected behind your Authelia/SSO middleware. You have to create a user with an email and password for Immich upon start up. Its recommended that you use the email and password you set up upon instalation for consistencies sake. | Details | | | @@ -38,7 +47,7 @@ sb install sandbox-immich ### 3. Setup -!!!info +!!! info 📢 Again, no default user is configured until you run through the setup screen, so you would ideally run through setup as soon as immich is deployed to secure the site. It is not behind authelia by default. ???tip diff --git a/docs/sandbox/apps/influxdb.md b/docs/sandbox/apps/influxdb.md index 4ca995690..92bd4ebe7 100644 --- a/docs/sandbox/apps/influxdb.md +++ b/docs/sandbox/apps/influxdb.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - influxdb + - database + - timeseries +--- + # InfluxDB ## What is it? diff --git a/docs/sandbox/apps/influxdb2.md b/docs/sandbox/apps/influxdb2.md index ec834f9ef..6912950bd 100644 --- a/docs/sandbox/apps/influxdb2.md +++ b/docs/sandbox/apps/influxdb2.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - influxdb2 + - database + - timeseries +--- + # InfluxDB2 ## What is it? diff --git a/docs/sandbox/apps/invoiceninja.md b/docs/sandbox/apps/invoiceninja.md index 7113ca7b1..92a96b9b5 100644 --- a/docs/sandbox/apps/invoiceninja.md +++ b/docs/sandbox/apps/invoiceninja.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - invoiceninja + - finance + - invoicing +--- + # Invoice Ninja v5 ## What is it? diff --git a/docs/sandbox/apps/jdownloader2.md b/docs/sandbox/apps/jdownloader2.md index c0fcef6e2..1855b9dff 100644 --- a/docs/sandbox/apps/jdownloader2.md +++ b/docs/sandbox/apps/jdownloader2.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - jdownloader2 + - download + - tools +--- + # JDownloader ## What is it? diff --git a/docs/sandbox/apps/jellyseerr.md b/docs/sandbox/apps/jellyseerr.md index d389668fa..0644edad4 100644 --- a/docs/sandbox/apps/jellyseerr.md +++ b/docs/sandbox/apps/jellyseerr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - jellyseerr + - media + - requests +--- + # Jellyseerr ## What is it? diff --git a/docs/sandbox/apps/joplin.md b/docs/sandbox/apps/joplin.md index 37d960c0c..b08ef90ed 100644 --- a/docs/sandbox/apps/joplin.md +++ b/docs/sandbox/apps/joplin.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - joplin + - productivity + - notes +--- + # Joplin ## What is it? diff --git a/docs/sandbox/apps/karakeep.md b/docs/sandbox/apps/karakeep.md index 6714980d7..adae56645 100644 --- a/docs/sandbox/apps/karakeep.md +++ b/docs/sandbox/apps/karakeep.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - karakeep + - media + - music +--- + # Karakeep [Karakeep](https://karakeep.app/) is an open source "Bookmark Everything" app that uses AI for automatically tagging the content you throw at it. The app is built with self-hosting as a first class citizen. diff --git a/docs/sandbox/apps/kavita.md b/docs/sandbox/apps/kavita.md index 99fb355d8..9f146b7c6 100644 --- a/docs/sandbox/apps/kavita.md +++ b/docs/sandbox/apps/kavita.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - kavita + - media + - books +--- + # Kavita ## What is it? diff --git a/docs/sandbox/apps/kcptun-client.md b/docs/sandbox/apps/kcptun-client.md index 03bf4397f..f5247a048 100644 --- a/docs/sandbox/apps/kcptun-client.md +++ b/docs/sandbox/apps/kcptun-client.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - kcptun-client + - tunnel + - networking +--- + # kcptun client ## What is it? diff --git a/docs/sandbox/apps/kcptun-server.md b/docs/sandbox/apps/kcptun-server.md index aba04182a..ba660fed4 100644 --- a/docs/sandbox/apps/kcptun-server.md +++ b/docs/sandbox/apps/kcptun-server.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - kcptun-server + - tunnel + - networking +--- + # kcptun server ## What is it? diff --git a/docs/sandbox/apps/kitana.md b/docs/sandbox/apps/kitana.md index 8f013b9c5..e37ecde4e 100644 --- a/docs/sandbox/apps/kitana.md +++ b/docs/sandbox/apps/kitana.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - kitana + - plex + - frontend +--- + # Kitana ## What is it? diff --git a/docs/sandbox/apps/komga.md b/docs/sandbox/apps/komga.md index ee769bd2e..2ce9d5546 100644 --- a/docs/sandbox/apps/komga.md +++ b/docs/sandbox/apps/komga.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - komga + - media + - comics +--- + # Komga ## What is it? diff --git a/docs/sandbox/apps/krusader.md b/docs/sandbox/apps/krusader.md index 09784b529..8e9cddc52 100644 --- a/docs/sandbox/apps/krusader.md +++ b/docs/sandbox/apps/krusader.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - krusader + - file-management + - admin +--- + # Krusader ## What is it? diff --git a/docs/sandbox/apps/lazylibrarian.md b/docs/sandbox/apps/lazylibrarian.md index ba8a66613..240f4ea20 100644 --- a/docs/sandbox/apps/lazylibrarian.md +++ b/docs/sandbox/apps/lazylibrarian.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - lazylibrarian + - media + - books +--- + # LazyLibrarian ## What is it? diff --git a/docs/sandbox/apps/lgsm.md b/docs/sandbox/apps/lgsm.md index 8011a83a9..4e4f0128e 100644 --- a/docs/sandbox/apps/lgsm.md +++ b/docs/sandbox/apps/lgsm.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - lgsm + - gaming + - server +--- + # LinuxGSM ## What is it? diff --git a/docs/sandbox/apps/linkding.md b/docs/sandbox/apps/linkding.md index 19b2e88a7..6d7abadb6 100644 --- a/docs/sandbox/apps/linkding.md +++ b/docs/sandbox/apps/linkding.md @@ -1,10 +1,19 @@ +--- +hide: + - tags +tags: + - linkding + - productivity + - bookmarks +--- + # Linkding ## What is it? [Linkding](https://github.com/sissbruecker/linkding#introduction) is a simple bookmark service that you can host yourself. It's designed be to be minimal and fast. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/logarr.md b/docs/sandbox/apps/logarr.md index ca71ed8ca..5f105e17c 100644 --- a/docs/sandbox/apps/logarr.md +++ b/docs/sandbox/apps/logarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - logarr + - monitoring + - logs +--- + # Logarr ALPHA ## What is it? diff --git a/docs/sandbox/apps/lunasea.md b/docs/sandbox/apps/lunasea.md index cd9b42d11..96c1a611c 100644 --- a/docs/sandbox/apps/lunasea.md +++ b/docs/sandbox/apps/lunasea.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - lunasea + - automation + - controller +--- + # Lunasea ## What is it? diff --git a/docs/sandbox/apps/maintainerr.md b/docs/sandbox/apps/maintainerr.md index 77e74046d..8c6b7a71a 100644 --- a/docs/sandbox/apps/maintainerr.md +++ b/docs/sandbox/apps/maintainerr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - maintainerr + - maintenance + - automation +--- + # Maintainerr # What is it? diff --git a/docs/sandbox/apps/makemkv.md b/docs/sandbox/apps/makemkv.md index 309c0c84e..f168f9274 100644 --- a/docs/sandbox/apps/makemkv.md +++ b/docs/sandbox/apps/makemkv.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - makemkv + - media + - ripping +--- + # MakeMKV ## What is it? diff --git a/docs/sandbox/apps/maybe-finance.md b/docs/sandbox/apps/maybe-finance.md index 8d191045c..9271556d8 100644 --- a/docs/sandbox/apps/maybe-finance.md +++ b/docs/sandbox/apps/maybe-finance.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - maybe-finance + - finance + - budgeting +--- + # Maybe Finance ## What is it? diff --git a/docs/sandbox/apps/mcrouter.md b/docs/sandbox/apps/mcrouter.md index b2b3b49b1..a89cd218a 100644 --- a/docs/sandbox/apps/mcrouter.md +++ b/docs/sandbox/apps/mcrouter.md @@ -11,7 +11,7 @@ tags: [MC Router](https://github.com/itzg/mc-router) Routes Minecraft client connections to backend servers based upon the requested server address. -!!! Note +!!! note MC Router is not intended to be used as a standalone server, but rather as a component of a larger Minecraft server network. It is installed in tandem with the [Minecraft](../apps/minecraft.md) role. | Details | | | | diff --git a/docs/sandbox/apps/mealie.md b/docs/sandbox/apps/mealie.md index 2fe1a0911..987c03316 100644 --- a/docs/sandbox/apps/mealie.md +++ b/docs/sandbox/apps/mealie.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - mealie + - recipes + - cooking +--- + # Mealie ## What is it? diff --git a/docs/sandbox/apps/medusa.md b/docs/sandbox/apps/medusa.md index b9df49a4b..a4c3defbd 100644 --- a/docs/sandbox/apps/medusa.md +++ b/docs/sandbox/apps/medusa.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - medusa + - media + - tv +--- + # Medusa ## What is it? diff --git a/docs/sandbox/apps/meilisearch.md b/docs/sandbox/apps/meilisearch.md index 3c17d1fbe..45bf628a4 100644 --- a/docs/sandbox/apps/meilisearch.md +++ b/docs/sandbox/apps/meilisearch.md @@ -1,4 +1,13 @@ -# Hoarder +--- +hide: + - tags +tags: + - meilisearch + - search + - database +--- + +# Meilisearch [Meilisearch](https://www.meilisearch.com/) Meilisearch is an AI powered search tool. diff --git a/docs/sandbox/apps/membarr.md b/docs/sandbox/apps/membarr.md index ec50eff8e..93b52cb06 100644 --- a/docs/sandbox/apps/membarr.md +++ b/docs/sandbox/apps/membarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - membarr + - discord + - automation +--- + # Membarr ## What is it? diff --git a/docs/sandbox/apps/miniflux.md b/docs/sandbox/apps/miniflux.md index daad3dc52..c6f6a5630 100644 --- a/docs/sandbox/apps/miniflux.md +++ b/docs/sandbox/apps/miniflux.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - miniflux + - media + - rss +--- + # miniflux ## What is it? diff --git a/docs/sandbox/apps/mkvtoolnix.md b/docs/sandbox/apps/mkvtoolnix.md index 3a0c95b65..25a948481 100644 --- a/docs/sandbox/apps/mkvtoolnix.md +++ b/docs/sandbox/apps/mkvtoolnix.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - mkvtoolnix + - media + - tools +--- + # MKVToolNix ## What is it? diff --git a/docs/sandbox/apps/monitorr.md b/docs/sandbox/apps/monitorr.md index 3425d62a6..39012b103 100644 --- a/docs/sandbox/apps/monitorr.md +++ b/docs/sandbox/apps/monitorr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - monitorr + - monitoring + - uptime +--- + # Monitorr ## What is it? diff --git a/docs/sandbox/apps/moviematch.md b/docs/sandbox/apps/moviematch.md index 190ec4a92..e5e5ec7e3 100644 --- a/docs/sandbox/apps/moviematch.md +++ b/docs/sandbox/apps/moviematch.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - moviematch + - plex + - recommendations +--- + # MovieMatch ## What is it? diff --git a/docs/sandbox/apps/mqtt.md b/docs/sandbox/apps/mqtt.md index 5ce5fbcd5..06a2dc02a 100644 --- a/docs/sandbox/apps/mqtt.md +++ b/docs/sandbox/apps/mqtt.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - mqtt + - automation + - messaging +--- + # MQTT ## What is it? diff --git a/docs/sandbox/apps/mylar3.md b/docs/sandbox/apps/mylar3.md index cf2208a04..c754c4c5b 100644 --- a/docs/sandbox/apps/mylar3.md +++ b/docs/sandbox/apps/mylar3.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - mylar3 + - media + - comics +--- + # Mylar3 ## What is it? diff --git a/docs/sandbox/apps/n8n.md b/docs/sandbox/apps/n8n.md index 9d26b0836..5a53e52fc 100644 --- a/docs/sandbox/apps/n8n.md +++ b/docs/sandbox/apps/n8n.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - n8n + - automation + - workflow +--- + # n8n ## What is it? @@ -10,7 +19,7 @@ - **Enterprise-Ready**: Advanced permissions, SSO, and air-gapped deployments - **Active Community**: 400+ integrations and 900+ ready-to-use [templates](https://n8n.io/workflows) -!!!info +!!! info By default, the role **IS** protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/nabarr.md b/docs/sandbox/apps/nabarr.md index e7364bf9a..65ac5f115 100644 --- a/docs/sandbox/apps/nabarr.md +++ b/docs/sandbox/apps/nabarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - nabarr + - automation + - rss +--- + # Nabarr ## What is it? diff --git a/docs/sandbox/apps/navidrome.md b/docs/sandbox/apps/navidrome.md index 3ad19b672..e413e84fd 100644 --- a/docs/sandbox/apps/navidrome.md +++ b/docs/sandbox/apps/navidrome.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - navidrome + - media + - music +--- + # Navidrome ## What is it? diff --git a/docs/sandbox/apps/nextcloud.md b/docs/sandbox/apps/nextcloud.md index 5389741ed..afcd3e418 100644 --- a/docs/sandbox/apps/nextcloud.md +++ b/docs/sandbox/apps/nextcloud.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - nextcloud + - productivity + - cloud +--- + # Nextcloud ## What is it? diff --git a/docs/sandbox/apps/node-red.md b/docs/sandbox/apps/node-red.md index dd003c6fd..35a0d5fb2 100644 --- a/docs/sandbox/apps/node-red.md +++ b/docs/sandbox/apps/node-red.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - node-red + - automation + - iot +--- + # Node Red ## What is it? diff --git a/docs/sandbox/apps/notifiarr.md b/docs/sandbox/apps/notifiarr.md index 04c050d32..6532f7e2d 100644 --- a/docs/sandbox/apps/notifiarr.md +++ b/docs/sandbox/apps/notifiarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - notifiarr + - discord + - notifications +--- + # Notifiarr Client ## What is it? diff --git a/docs/sandbox/apps/olivetin.md b/docs/sandbox/apps/olivetin.md index 5554cb316..f3298c3ac 100644 --- a/docs/sandbox/apps/olivetin.md +++ b/docs/sandbox/apps/olivetin.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - olivetin + - automation + - admin +--- + # OliveTin ## What is it? diff --git a/docs/sandbox/apps/ombi.md b/docs/sandbox/apps/ombi.md index 103d936af..e2093e38c 100644 --- a/docs/sandbox/apps/ombi.md +++ b/docs/sandbox/apps/ombi.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - ombi + - requests + - automation +--- + # Ombi ## What is it? diff --git a/docs/sandbox/apps/ombix.md b/docs/sandbox/apps/ombix.md index e65cc9eab..0f147db51 100644 --- a/docs/sandbox/apps/ombix.md +++ b/docs/sandbox/apps/ombix.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - ombix + - requests + - automation +--- + # Ombi**X** ## What is it? diff --git a/docs/sandbox/apps/paperless-ngx.md b/docs/sandbox/apps/paperless-ngx.md index b11abcbaf..c5af2f90a 100644 --- a/docs/sandbox/apps/paperless-ngx.md +++ b/docs/sandbox/apps/paperless-ngx.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - paperless-ngx + - productivity + - documents +--- + # Paperless NGX ## What is it? diff --git a/docs/sandbox/apps/pgadmin.md b/docs/sandbox/apps/pgadmin.md index 8e07bbc62..f72bdea00 100644 --- a/docs/sandbox/apps/pgadmin.md +++ b/docs/sandbox/apps/pgadmin.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - pgadmin + - database + - admin +--- + # pgadmin ## What is it? diff --git a/docs/sandbox/apps/photoprism.md b/docs/sandbox/apps/photoprism.md index 42396f0e8..2d7beba52 100644 --- a/docs/sandbox/apps/photoprism.md +++ b/docs/sandbox/apps/photoprism.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - photoprism + - photos + - ai +--- + # Photoprism ## What is it? diff --git a/docs/sandbox/apps/phpmyadmin.md b/docs/sandbox/apps/phpmyadmin.md index 06ed2972c..f6e44ed17 100644 --- a/docs/sandbox/apps/phpmyadmin.md +++ b/docs/sandbox/apps/phpmyadmin.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - phpmyadmin + - database + - admin +--- + # phpmyadmin ## What is it? diff --git a/docs/sandbox/apps/plex-auto-languages.md b/docs/sandbox/apps/plex-auto-languages.md index 5ae55f4b0..10f7aa486 100644 --- a/docs/sandbox/apps/plex-auto-languages.md +++ b/docs/sandbox/apps/plex-auto-languages.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - plex-auto-languages + - plex + - automation +--- + # plex_auto_languages ## What is it? diff --git a/docs/sandbox/apps/plex-dupefinder.md b/docs/sandbox/apps/plex-dupefinder.md index 2e1d1be2a..b9308af58 100644 --- a/docs/sandbox/apps/plex-dupefinder.md +++ b/docs/sandbox/apps/plex-dupefinder.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - plex-dupefinder + - plex + - cleanup +--- + # Plex_Dupefinder ## What is it? diff --git a/docs/sandbox/apps/plex-patrol.md b/docs/sandbox/apps/plex-patrol.md index 372728615..a6efffad4 100644 --- a/docs/sandbox/apps/plex-patrol.md +++ b/docs/sandbox/apps/plex-patrol.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - plex-patrol + - plex + - monitoring +--- + # plex_patrol ## What is it? diff --git a/docs/sandbox/apps/plex-utills.md b/docs/sandbox/apps/plex-utills.md index ee0f4568d..b6a97471e 100644 --- a/docs/sandbox/apps/plex-utills.md +++ b/docs/sandbox/apps/plex-utills.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - plex-utills + - plex + - enhancement +--- + # Plex Utills ## What is it? diff --git a/docs/sandbox/apps/privatebin.md b/docs/sandbox/apps/privatebin.md index c38c099dc..48d1dadbd 100644 --- a/docs/sandbox/apps/privatebin.md +++ b/docs/sandbox/apps/privatebin.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - privatebin + - pastebin + - privacy +--- + # PrivateBin ## What is it? diff --git a/docs/sandbox/apps/puddletag.md b/docs/sandbox/apps/puddletag.md index 9588e8bbc..7119c3cad 100644 --- a/docs/sandbox/apps/puddletag.md +++ b/docs/sandbox/apps/puddletag.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - puddletag + - media + - tagging +--- + # Puddletag ## What is it? diff --git a/docs/sandbox/apps/pyload.md b/docs/sandbox/apps/pyload.md index 356bb0a3b..4db0cd611 100644 --- a/docs/sandbox/apps/pyload.md +++ b/docs/sandbox/apps/pyload.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - pyload + - download + - tools +--- + # pyload ## THIS DOCUMENTATION IS NOT YET COMPLETED diff --git a/docs/sandbox/apps/python-plexlibrary.md b/docs/sandbox/apps/python-plexlibrary.md index 7444447f9..d5322b0bd 100644 --- a/docs/sandbox/apps/python-plexlibrary.md +++ b/docs/sandbox/apps/python-plexlibrary.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - python-plexlibrary + - plex + - library +--- + # python-plexlibrary ## THIS DOCUMENTATION IS NOT YET COMPLETED diff --git a/docs/sandbox/apps/qbit-manage.md b/docs/sandbox/apps/qbit-manage.md index 0dd30bc58..ff56e4ab7 100644 --- a/docs/sandbox/apps/qbit-manage.md +++ b/docs/sandbox/apps/qbit-manage.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - qbit-manage + - torrent + - automation +--- + # qBit Manage ## What is it? diff --git a/docs/sandbox/apps/qbittorrentvpn.md b/docs/sandbox/apps/qbittorrentvpn.md index 4c3c6a05d..1b33a75ba 100644 --- a/docs/sandbox/apps/qbittorrentvpn.md +++ b/docs/sandbox/apps/qbittorrentvpn.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - qbittorrentvpn + - download + - vpn +--- + # qBittorrentvpn ## What is it? diff --git a/docs/sandbox/apps/rdtclient.md b/docs/sandbox/apps/rdtclient.md index 6152b213d..58c17bf46 100644 --- a/docs/sandbox/apps/rdtclient.md +++ b/docs/sandbox/apps/rdtclient.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - rdtclient + - download + - client +--- + # rdtclient ## THIS DOCUMENTATION IS NOT YET COMPLETED diff --git a/docs/sandbox/apps/reposilite.md b/docs/sandbox/apps/reposilite.md index 090c3f00d..01be35b09 100644 --- a/docs/sandbox/apps/reposilite.md +++ b/docs/sandbox/apps/reposilite.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - reposilite + - development + - repository +--- + # reposilite ## What is it? diff --git a/docs/sandbox/apps/requestrr.md b/docs/sandbox/apps/requestrr.md index 7c1c6783f..ce0c62ba9 100644 --- a/docs/sandbox/apps/requestrr.md +++ b/docs/sandbox/apps/requestrr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - requestrr + - discord + - automation +--- + # Requestrr ## What is it? diff --git a/docs/sandbox/apps/requestrrx.md b/docs/sandbox/apps/requestrrx.md index 9a460d4d4..7bbbbb1ed 100644 --- a/docs/sandbox/apps/requestrrx.md +++ b/docs/sandbox/apps/requestrrx.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - requestrrx + - discord + - automation +--- + # Requestrr**X** ## What is it? diff --git a/docs/sandbox/apps/resiliosync.md b/docs/sandbox/apps/resiliosync.md index a8e735264..1bc35a368 100644 --- a/docs/sandbox/apps/resiliosync.md +++ b/docs/sandbox/apps/resiliosync.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - resiliosync + - backup + - sync +--- + # Resilio Sync ## What is it? diff --git a/docs/sandbox/apps/rflood.md b/docs/sandbox/apps/rflood.md index 28fb1def7..35d5cf4e2 100644 --- a/docs/sandbox/apps/rflood.md +++ b/docs/sandbox/apps/rflood.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - rflood + - torrent + - frontend +--- + # rFlood ## What is it? diff --git a/docs/sandbox/apps/rfloodx.md b/docs/sandbox/apps/rfloodx.md index a0157fa55..daa5fd56c 100644 --- a/docs/sandbox/apps/rfloodx.md +++ b/docs/sandbox/apps/rfloodx.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - rfloodx + - torrent + - frontend +--- + # rFlood**X** ## What is it? diff --git a/docs/sandbox/apps/rocketchat.md b/docs/sandbox/apps/rocketchat.md index 4fae09515..ccf6c10f8 100644 --- a/docs/sandbox/apps/rocketchat.md +++ b/docs/sandbox/apps/rocketchat.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - rocketchat + - communication + - chat +--- + # rocketchat ## THIS DOCUMENTATION IS NOT YET COMPLETED diff --git a/docs/sandbox/apps/sabthrottle.md b/docs/sandbox/apps/sabthrottle.md index 1f74f987e..e4c277d2a 100644 --- a/docs/sandbox/apps/sabthrottle.md +++ b/docs/sandbox/apps/sabthrottle.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - sabthrottle + - automation + - bandwidth +--- + # SABThrottle ## What is it? diff --git a/docs/sandbox/apps/sarotate.md b/docs/sandbox/apps/sarotate.md index e7eee99e3..2388f9532 100644 --- a/docs/sandbox/apps/sarotate.md +++ b/docs/sandbox/apps/sarotate.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - sarotate + - automation + - google +--- + # Sarotate ## What is it? diff --git a/docs/sandbox/apps/semaphoreui.md b/docs/sandbox/apps/semaphoreui.md index 46b6022f2..1a9a17847 100644 --- a/docs/sandbox/apps/semaphoreui.md +++ b/docs/sandbox/apps/semaphoreui.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - semaphoreui + - ansible + - automation +--- + # SemaphoreUI ## What is it? diff --git a/docs/sandbox/apps/speedtest.md b/docs/sandbox/apps/speedtest.md index cde3eb88d..9f126c7fc 100644 --- a/docs/sandbox/apps/speedtest.md +++ b/docs/sandbox/apps/speedtest.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - speedtest + - monitoring + - network +--- + # Speedtest ## What is it? diff --git a/docs/sandbox/apps/sqlitebrowser.md b/docs/sandbox/apps/sqlitebrowser.md index 7b2aa5c83..78380323b 100644 --- a/docs/sandbox/apps/sqlitebrowser.md +++ b/docs/sandbox/apps/sqlitebrowser.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - sqlitebrowser + - database + - utility +--- + # SQLite Browser ## What is it? diff --git a/docs/sandbox/apps/sshwifty.md b/docs/sandbox/apps/sshwifty.md index efef0fb94..25421c768 100644 --- a/docs/sandbox/apps/sshwifty.md +++ b/docs/sandbox/apps/sshwifty.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - sshwifty + - networking + - ssh +--- + # Sshwifty ## What is it? diff --git a/docs/sandbox/apps/stash.md b/docs/sandbox/apps/stash.md index 1985b5c0b..6294680ae 100644 --- a/docs/sandbox/apps/stash.md +++ b/docs/sandbox/apps/stash.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - stash + - media + - organizer +--- + # Stash ## What is it? diff --git a/docs/sandbox/apps/syncthing.md b/docs/sandbox/apps/syncthing.md index 621c1f742..2648f2d40 100644 --- a/docs/sandbox/apps/syncthing.md +++ b/docs/sandbox/apps/syncthing.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - syncthing + - backup + - sync +--- + # Syncthing ## What is it? diff --git a/docs/sandbox/apps/tandoor.md b/docs/sandbox/apps/tandoor.md index 6a4b68404..f09d9a2b2 100644 --- a/docs/sandbox/apps/tandoor.md +++ b/docs/sandbox/apps/tandoor.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tandoor + - recipes + - planning +--- + # Tandoor Recipes ## What is it? diff --git a/docs/sandbox/apps/tauticord.md b/docs/sandbox/apps/tauticord.md index eaa5a4c73..909dc02d6 100644 --- a/docs/sandbox/apps/tauticord.md +++ b/docs/sandbox/apps/tauticord.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tauticord + - discord + - monitoring +--- + # Tauticord ## What is it? diff --git a/docs/sandbox/apps/tdarr-node.md b/docs/sandbox/apps/tdarr-node.md index ad01a5af2..84b1b68e2 100644 --- a/docs/sandbox/apps/tdarr-node.md +++ b/docs/sandbox/apps/tdarr-node.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tdarr-node + - media + - encoding +--- + # Tdarr Node ## What is it? diff --git a/docs/sandbox/apps/tdarr.md b/docs/sandbox/apps/tdarr.md index f7d67c414..83ca69cd0 100644 --- a/docs/sandbox/apps/tdarr.md +++ b/docs/sandbox/apps/tdarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tdarr + - media + - encoding +--- + # Tdarr ## What is it? diff --git a/docs/sandbox/apps/telegraf.md b/docs/sandbox/apps/telegraf.md index ad389e5b7..e5ca9fefd 100644 --- a/docs/sandbox/apps/telegraf.md +++ b/docs/sandbox/apps/telegraf.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - telegraf + - monitoring + - metrics +--- + # Telegraf ## What is it? diff --git a/docs/sandbox/apps/teslamate.md b/docs/sandbox/apps/teslamate.md index ed53852a1..8d262d5e4 100644 --- a/docs/sandbox/apps/teslamate.md +++ b/docs/sandbox/apps/teslamate.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - teslamate + - tesla + - monitoring +--- + # Teslamate ## What is it? diff --git a/docs/sandbox/apps/thelounge.md b/docs/sandbox/apps/thelounge.md index 50568acf3..31e928cd7 100644 --- a/docs/sandbox/apps/thelounge.md +++ b/docs/sandbox/apps/thelounge.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - thelounge + - irc + - chat +--- + # The Lounge ## What is it? diff --git a/docs/sandbox/apps/threadfin.md b/docs/sandbox/apps/threadfin.md index dfc4ef2c1..5d49f1970 100644 --- a/docs/sandbox/apps/threadfin.md +++ b/docs/sandbox/apps/threadfin.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - threadfin + - iptv + - streaming +--- + # Threadfin ## What is it? diff --git a/docs/sandbox/apps/tika.md b/docs/sandbox/apps/tika.md index 894a4cf2d..b1630f4fc 100644 --- a/docs/sandbox/apps/tika.md +++ b/docs/sandbox/apps/tika.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tika + - extraction + - utility +--- + # tika ## THIS DOCUMENTATION IS NOT YET COMPLETED diff --git a/docs/sandbox/apps/tqm.md b/docs/sandbox/apps/tqm.md index ecfe9ae3c..58344eb2f 100644 --- a/docs/sandbox/apps/tqm.md +++ b/docs/sandbox/apps/tqm.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tqm + - torrent + - automation +--- + # tqm ## What is it? diff --git a/docs/sandbox/apps/trackarr.md b/docs/sandbox/apps/trackarr.md index 8084474e3..291ccbcdf 100644 --- a/docs/sandbox/apps/trackarr.md +++ b/docs/sandbox/apps/trackarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - trackarr + - automation + - tracker +--- + # Trackarr ## What is it? diff --git a/docs/sandbox/apps/traefik-robotstxt.md b/docs/sandbox/apps/traefik-robotstxt.md index 4f28a2852..eec05db19 100644 --- a/docs/sandbox/apps/traefik-robotstxt.md +++ b/docs/sandbox/apps/traefik-robotstxt.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - traefik-robotstxt + - networking + - seo +--- + # Robotstxt ## What is it? diff --git a/docs/sandbox/apps/transmission.md b/docs/sandbox/apps/transmission.md index 55aa3c583..5fe0bff44 100644 --- a/docs/sandbox/apps/transmission.md +++ b/docs/sandbox/apps/transmission.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - transmission + - download + - torrent +--- + # Transmission ## What is it? diff --git a/docs/sandbox/apps/transmissionvpn.md b/docs/sandbox/apps/transmissionvpn.md index 02780644a..d8581995b 100644 --- a/docs/sandbox/apps/transmissionvpn.md +++ b/docs/sandbox/apps/transmissionvpn.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - transmissionvpn + - download + - vpn +--- + # transmissionvpn ## THIS DOCUMENTATION IS NOT YET COMPLETED diff --git a/docs/sandbox/apps/transmissionx.md b/docs/sandbox/apps/transmissionx.md index 742e69a29..b1405212a 100644 --- a/docs/sandbox/apps/transmissionx.md +++ b/docs/sandbox/apps/transmissionx.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - transmissionx + - torrent + - download +--- + # Transmission**X** ## What is it? diff --git a/docs/sandbox/apps/trilium.md b/docs/sandbox/apps/trilium.md index 084808df3..ef83e25e3 100644 --- a/docs/sandbox/apps/trilium.md +++ b/docs/sandbox/apps/trilium.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - trilium + - productivity + - notes +--- + # Trilium Notes ## What is it? diff --git a/docs/sandbox/apps/tubearchivist.md b/docs/sandbox/apps/tubearchivist.md index a5a79d4da..813bd864f 100644 --- a/docs/sandbox/apps/tubearchivist.md +++ b/docs/sandbox/apps/tubearchivist.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tubearchivist + - media + - youtube +--- + # Tubearchivist ## What is it? diff --git a/docs/sandbox/apps/tvheadend.md b/docs/sandbox/apps/tvheadend.md index 7ed231196..0b2d28b20 100644 --- a/docs/sandbox/apps/tvheadend.md +++ b/docs/sandbox/apps/tvheadend.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tvheadend + - tv + - streaming +--- + # Tvheadend ## What is it? diff --git a/docs/sandbox/apps/unifi-network-application.md b/docs/sandbox/apps/unifi-network-application.md index 7927cbb1c..699cd7671 100644 --- a/docs/sandbox/apps/unifi-network-application.md +++ b/docs/sandbox/apps/unifi-network-application.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - unifi + - networking + - wireless +--- + # Unifi Network Application ## What is it? diff --git a/docs/sandbox/apps/unmanic.md b/docs/sandbox/apps/unmanic.md index 209542243..6521299d2 100644 --- a/docs/sandbox/apps/unmanic.md +++ b/docs/sandbox/apps/unmanic.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - unmanic + - media + - encoding +--- + # Unmanic ## What is it? diff --git a/docs/sandbox/apps/uptime-kuma.md b/docs/sandbox/apps/uptime-kuma.md index 6cf433021..08f39470c 100644 --- a/docs/sandbox/apps/uptime-kuma.md +++ b/docs/sandbox/apps/uptime-kuma.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - uptime-kuma + - monitoring + - uptime +--- + # Uptime Kuma ## What is it? diff --git a/docs/sandbox/apps/varken.md b/docs/sandbox/apps/varken.md index 962b24690..17b5df106 100644 --- a/docs/sandbox/apps/varken.md +++ b/docs/sandbox/apps/varken.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - varken + - monitoring + - analytics +--- + # Varken ## What is it? diff --git a/docs/sandbox/apps/vaultwarden.md b/docs/sandbox/apps/vaultwarden.md index fb2df412c..c7605ade3 100644 --- a/docs/sandbox/apps/vaultwarden.md +++ b/docs/sandbox/apps/vaultwarden.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - vaultwarden + - passwords + - security +--- + # vaultwarden ## What is it? diff --git a/docs/sandbox/apps/vnstat.md b/docs/sandbox/apps/vnstat.md index 95ede8280..c2a891c8e 100644 --- a/docs/sandbox/apps/vnstat.md +++ b/docs/sandbox/apps/vnstat.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - vnstat + - monitoring + - network +--- + # vnStat ## What is it? diff --git a/docs/sandbox/apps/watchtower.md b/docs/sandbox/apps/watchtower.md index 0867194b1..4fef0aa84 100644 --- a/docs/sandbox/apps/watchtower.md +++ b/docs/sandbox/apps/watchtower.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - watchtower + - monitoring + - docker +--- + # Watchtower ## What is it? diff --git a/docs/sandbox/apps/wikijs.md b/docs/sandbox/apps/wikijs.md index 3ddbcb1f5..539dc4351 100644 --- a/docs/sandbox/apps/wikijs.md +++ b/docs/sandbox/apps/wikijs.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - wikijs + - documentation + - wiki +--- + # Wikijs ## What is it? @@ -8,7 +17,7 @@ - Fully customize the appearance of your wiki, including a light and dark mode. - Make your wiki public, completely private or a mix of both. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into Wikijs with the email and password you set up upon instalation. | Details | | | | @@ -29,7 +38,7 @@ sb install sandbox-wikijs ### 3. Setup -!!!info +!!! info 📢 No default user is configured until you run through the setup screen, so you should ideally run through setup as soon as the container is deployed to secure the site. It is not behind authelia by default. - [:octicons-link-16: Documentation: Wikijs Docs](https://docs.requarks.io/){: .header-icons } diff --git a/docs/sandbox/apps/wizarr.md b/docs/sandbox/apps/wizarr.md index 69da35d75..303e64853 100644 --- a/docs/sandbox/apps/wizarr.md +++ b/docs/sandbox/apps/wizarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - wizarr + - automation + - invitations +--- + # Wizarr ## What is it? diff --git a/docs/sandbox/apps/wordpress.md b/docs/sandbox/apps/wordpress.md index 3fa62ead0..b07f73269 100644 --- a/docs/sandbox/apps/wordpress.md +++ b/docs/sandbox/apps/wordpress.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - wordpress + - cms + - web +--- + # WordPress ## What is it? diff --git a/docs/sandbox/apps/wrapperr.md b/docs/sandbox/apps/wrapperr.md index 2a1bf5ee5..98704f301 100644 --- a/docs/sandbox/apps/wrapperr.md +++ b/docs/sandbox/apps/wrapperr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - wrapperr + - statistics + - analytics +--- + # Wrapperr ## What is it? diff --git a/docs/sandbox/apps/xbackbone.md b/docs/sandbox/apps/xbackbone.md index 987b346d6..3f582bab4 100644 --- a/docs/sandbox/apps/xbackbone.md +++ b/docs/sandbox/apps/xbackbone.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - xbackbone + - file-sharing + - upload +--- + # xbackbone ## THIS DOCUMENTATION IS NOT YET COMPLETED diff --git a/docs/sandbox/apps/xteve.md b/docs/sandbox/apps/xteve.md index aa903d2e9..22f023c9d 100644 --- a/docs/sandbox/apps/xteve.md +++ b/docs/sandbox/apps/xteve.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - xteve + - iptv + - streaming +--- + # xTeVe ## What is it? diff --git a/docs/sandbox/apps/yacht.md b/docs/sandbox/apps/yacht.md index 4bb460abe..fa6f454e4 100644 --- a/docs/sandbox/apps/yacht.md +++ b/docs/sandbox/apps/yacht.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - yacht + - docker + - management +--- + # Yacht ## What is it? diff --git a/docs/sandbox/apps/yourspotify.md b/docs/sandbox/apps/yourspotify.md index 5f5eb5054..34dc6ecf3 100644 --- a/docs/sandbox/apps/yourspotify.md +++ b/docs/sandbox/apps/yourspotify.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - yourspotify + - spotify + - analytics +--- + # Yourspotify ## What is it? @@ -6,7 +15,7 @@ Note that while the documentation linked here is for the original project, the Docker image linked below is a fork of the original project. Particularly the [linuxserver/your_spotify](https://github.com/linuxserver/docker-your_spotify) image. -!!!info +!!! info By default, the role is **NOT** protected behind your Authelia/SSO middleware. You have to log into the role itself. | Details | | | | diff --git a/docs/sandbox/apps/znc.md b/docs/sandbox/apps/znc.md index f77f92226..c6905207f 100644 --- a/docs/sandbox/apps/znc.md +++ b/docs/sandbox/apps/znc.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - znc + - irc + - bouncer +--- + # ZNC ## What is it? From 4ffcf03ccab42cb0bb6282b939b9b5cbca4fa3f4 Mon Sep 17 00:00:00 2001 From: owine Date: Sat, 12 Jul 2025 15:46:02 -0500 Subject: [PATCH 03/16] Fix image alt text in Plex documentation - Add descriptive alt text for folder selection images - Improves accessibility compliance - Replaces empty space alt text with meaningful descriptions --- docs/apps/plex.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/apps/plex.md b/docs/apps/plex.md index 4ad705edb..56f36f1d2 100644 --- a/docs/apps/plex.md +++ b/docs/apps/plex.md @@ -178,7 +178,7 @@ _Note: If you would like to have custom Plex libraries (more than just a Movies 4. Navigate to `/mnt/unionfs/Media/Movies`, and then click the "ADD" button. - ![ ](../images/plex-media-server/plex-15-movies-choose-folder.png) + ![Plex movie folder selection](../images/plex-media-server/plex-15-movies-choose-folder.png) 5. You will now see `/mnt/unionfs/Media/Movies` in the text box (don't click "ADD LIBRARY" yet). @@ -214,7 +214,7 @@ _Note: If you would like to have custom Plex libraries (more than just a Movies 4. Navigate to `/mnt/unionfs/Media/TV`, and then click the "ADD" button. - ![ ](../images/plex-media-server/plex-21-tv-choose-folder.png) + ![Plex TV folder selection](../images/plex-media-server/plex-21-tv-choose-folder.png) 5. You will now see `/mnt/unionfs/Media/TV` in the text box (don't click "ADD LIBRARY" yet). From eba7197a5a1080ee2191131d81cd754b74e30f58 Mon Sep 17 00:00:00 2001 From: owine Date: Sat, 12 Jul 2025 15:53:18 -0500 Subject: [PATCH 04/16] Fix internal links after file renames - Update all references to renamed files - Fix broken links to accessing-apps.md, install-types.md, hetzner-nfs.md - Ensures documentation builds without warnings --- docs/reference/domain.md | 6 +++--- docs/reference/local-storage.md | 2 +- docs/saltbox/basics/update.md | 2 +- docs/saltbox/install/install.md | 16 ++++++++-------- docs/saltbox/prerequisites/prerequisites.md | 4 ++-- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/reference/domain.md b/docs/reference/domain.md index 0e226e4ee..20070c860 100644 --- a/docs/reference/domain.md +++ b/docs/reference/domain.md @@ -7,7 +7,7 @@ tags: ## Domain Name -**You will need a domain name** as Saltbox apps are only accessed via ._yourdomain.com_ (see [Accessing Saltbox Apps](../saltbox/basics/accessing_apps.md)). The steps below will help you set up a domain and DNS settings for use with Saltbox. +**You will need a domain name** as Saltbox apps are only accessed via ._yourdomain.com_ (see [Accessing Saltbox Apps](../saltbox/basics/accessing-apps.md)). The steps below will help you set up a domain and DNS settings for use with Saltbox. Ports are [for the most part] bound only to the internal `saltbox` docker network, which means they are not visible on the host; you won't be able to connect externally to the apps using `IP:PORT`. @@ -33,7 +33,7 @@ Pick one of the setups below. Your choice will depend on whether you meet certai - For DNS providers that allow wildcards. - - For [Saltbox install type](../saltbox/basics/install_types.md). + - For [Saltbox install type](../saltbox/basics/install-types.md). **Steps:** @@ -57,7 +57,7 @@ Pick one of the setups below. Your choice will depend on whether you meet certai - For DNS providers that do not allow wildcards (e.g. Freenom). - - For [Mediabox / Feederbox install types](../saltbox/basics/install_types.md). + - For [Mediabox / Feederbox install types](../saltbox/basics/install-types.md). - For Cloudflare users. diff --git a/docs/reference/local-storage.md b/docs/reference/local-storage.md index 4efb1ac66..931d7a70d 100644 --- a/docs/reference/local-storage.md +++ b/docs/reference/local-storage.md @@ -11,7 +11,7 @@ tags: You may want to set saltbox up to use "local storage". This article is assuming you are doing this as part of the initial setup, not switching from cloud to local. !!! info - This article is also assuming that you are using an all-in-one `saltbox` in your home, not something like multiple hetzner boxes pointed at a hetzner storage server. That's not "local storage" for the purposes of this article. As one specific example, the [Hetzner NFS stuff](../apps/hetzner_nfs.md) instructions are incompatible with the suggestions made here. + This article is also assuming that you are using an all-in-one `saltbox` in your home, not something like multiple hetzner boxes pointed at a hetzner storage server. That's not "local storage" for the purposes of this article. As one specific example, the [Hetzner NFS stuff](../apps/hetzner-nfs.md) instructions are incompatible with the suggestions made here. "Local storage" can mean a couple different things. diff --git a/docs/saltbox/basics/update.md b/docs/saltbox/basics/update.md index 35b0d3a78..4a8b08eaf 100644 --- a/docs/saltbox/basics/update.md +++ b/docs/saltbox/basics/update.md @@ -46,4 +46,4 @@ sb install saltbox This will do as above for *all* the containers installed by the `saltbox` tag. -Next, let's discuss how you will [access the applications](accessing_apps.md). +Next, let's discuss how you will [access the applications](accessing-apps.md). diff --git a/docs/saltbox/install/install.md b/docs/saltbox/install/install.md index b9affcaaf..f9ec7e2cf 100644 --- a/docs/saltbox/install/install.md +++ b/docs/saltbox/install/install.md @@ -201,13 +201,13 @@ To edit any of the following configuration files use the command written in the transcodes: /mnt/local/transcodes # (17)! ``` - 1. If the current server should have Authelia installed or use one installed elsewhere. For a multi-server setup, review the [considerations](../basics/install_types.md#feederboxmediabox-setup-considerations) listed for your Authelia setup. + 1. If the current server should have Authelia installed or use one installed elsewhere. For a multi-server setup, review the [considerations](../basics/install-types.md#feederboxmediabox-setup-considerations) listed for your Authelia setup. 2. Subdomain used for Authelia. Use different values here when using a Mediabox + Feederbox setup if deploying multiple Authelia instances. - On a Feederbox where you want to use Authelia on the Mediabox just put in the same subdomain the Mediabox uses for Authelia (master having been set to no on the Feederbox). Review the [considerations](../basics/install_types.md#feederboxmediabox-setup-considerations) listed for your Authelia setup. + On a Feederbox where you want to use Authelia on the Mediabox just put in the same subdomain the Mediabox uses for Authelia (master having been set to no on the Feederbox). Review the [considerations](../basics/install-types.md#feederboxmediabox-setup-considerations) listed for your Authelia setup. 3. Folder used for docker /downloads volume. Does not affect mergerfs (/mnt/unionfs). @@ -478,13 +478,13 @@ Once you have set up your rclone remote[s], enter their details in `settings.yml !!! warning Have you either disabled rclone OR set up your remotes in both `rclone config` and `settings.yml`? If not, go back and fix that. -If you are installing a [Feederbox/Mediabox setup](../basics/install_types.md) [if your reaction to this question is "huh?" then you are not, and should probably use the `saltbox` install], set up the Feederbox first, then add the [feeder mount](../../advanced/feeder.md) to the mediabox prior to install. +If you are installing a [Feederbox/Mediabox setup](../basics/install-types.md) [if your reaction to this question is "huh?" then you are not, and should probably use the `saltbox` install], set up the Feederbox first, then add the [feeder mount](../../advanced/feeder.md) to the mediabox prior to install. You can get a list of available install tags with `sb list`. === "Saltbox" - `saltbox` is an all-in-one media server for downloading and playback. It installs `core` and a set of application as described [here](../basics/install_types.md) + `saltbox` is an all-in-one media server for downloading and playback. It installs `core` and a set of application as described [here](../basics/install-types.md) ```shell sb install saltbox @@ -493,7 +493,7 @@ You can get a list of available install tags with `sb list`. === "Mediabox [playback]" - `mediabox` is just the parts required for playback. It installs `core` and a set of application as described [here](../basics/install_types.md) + `mediabox` is just the parts required for playback. It installs `core` and a set of application as described [here](../basics/install-types.md) ```shell sb install mediabox @@ -502,7 +502,7 @@ You can get a list of available install tags with `sb list`. === "Feederbox [downloading]" - `feederbox` is just the parts required for downloading. It installs `core` and a set of application as described [here](../basics/install_types.md) + `feederbox` is just the parts required for downloading. It installs `core` and a set of application as described [here](../basics/install-types.md) ```shell sb install feederbox @@ -511,7 +511,7 @@ You can get a list of available install tags with `sb list`. === "Core [minimal]" - `core` is the bare minimum required for saltbox. It installs the basics as described [here](../basics/install_types.md) + `core` is the bare minimum required for saltbox. It installs the basics as described [here](../basics/install-types.md) ```shell sb install core @@ -520,7 +520,7 @@ You can get a list of available install tags with `sb list`. === "Dealer's choice" - If you want to install a personal selection of apps, install `core` and the app tags you want as listed [here](../basics/install_types.md) + If you want to install a personal selection of apps, install `core` and the app tags you want as listed [here](../basics/install-types.md) ```shell sb install core,plex,sonarr,radarr,jackett,qbittorrent diff --git a/docs/saltbox/prerequisites/prerequisites.md b/docs/saltbox/prerequisites/prerequisites.md index 33ef33fa9..82f9fced6 100644 --- a/docs/saltbox/prerequisites/prerequisites.md +++ b/docs/saltbox/prerequisites/prerequisites.md @@ -70,7 +70,7 @@ The server will need to be accessible from the internet via ports 22 [or whateve ## Domain -**You will need a domain name** as Saltbox apps are only accessed via .*yourdomain.com* (see [Accessing Apps](../basics/accessing_apps.md)). +**You will need a domain name** as Saltbox apps are only accessed via .*yourdomain.com* (see [Accessing Apps](../basics/accessing-apps.md)). Ports are [for the most part] bound only to the internal `saltbox` docker network, which means they are not visible on the host; you **won't be able to connect** to the apps using `IP:PORT`. @@ -102,4 +102,4 @@ You won't need these particular [media source] details for the initial install, See [here](../../reference/usenet-torrent.md) for more details about media source requirements. -Next, let's discuss Saltbox [Install types](../basics/install_types.md). +Next, let's discuss Saltbox [Install types](../basics/install-types.md). From ffc7ee3dd7b437e3bd48598290a5758984a21336 Mon Sep 17 00:00:00 2001 From: owine Date: Sat, 12 Jul 2025 15:55:51 -0500 Subject: [PATCH 05/16] Fix ruTorrent.md filename case sensitivity issue - Properly rename ruTorrent.md to rutorrent.md - Resolves navigation mismatch in mkdocs.yml - Fixes case-sensitive filesystem compatibility --- docs/faq/{ruTorrent.md => rutorrent.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/faq/{ruTorrent.md => rutorrent.md} (100%) diff --git a/docs/faq/ruTorrent.md b/docs/faq/rutorrent.md similarity index 100% rename from docs/faq/ruTorrent.md rename to docs/faq/rutorrent.md From 0155b746b840ed4140d447af9ea7672495757839 Mon Sep 17 00:00:00 2001 From: owine Date: Sat, 12 Jul 2025 16:02:55 -0500 Subject: [PATCH 06/16] ruTorrent fix --- docs/apps/rutorrent.md | 2 +- docs/reference/usenet-torrent.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/apps/rutorrent.md b/docs/apps/rutorrent.md index e4101017f..7eab53813 100644 --- a/docs/apps/rutorrent.md +++ b/docs/apps/rutorrent.md @@ -13,7 +13,7 @@ THIS PAGE HAS NOT BEEN FULLY UPDATED FOR SALTBOX [ruTorrent](https://github.com/Novik/ruTorrent) (by Novik) is a front-end for the popular, lightweight, and extensible BitTorrent client [rtorrent](https://github.com/rakshasa/rtorrent) (by Jari Sundell aka rakshasa). -_Note: public trackers are disabled by default in the standard install. Refer to the FAQ for [instructions on re-enabling them](../faq/ruTorrent.md?h=public#enable-access-to-public-torrent-trackers)._ +_Note: public trackers are disabled by default in the standard install. Refer to the FAQ for [instructions on re-enabling them](../faq/rutorrent.md?h=public#enable-access-to-public-torrent-trackers)._ | Details | | | | | |-------------|-------------|-------------|-------------|-------------| diff --git a/docs/reference/usenet-torrent.md b/docs/reference/usenet-torrent.md index 111ccbaad..be0807d0f 100644 --- a/docs/reference/usenet-torrent.md +++ b/docs/reference/usenet-torrent.md @@ -18,4 +18,4 @@ If you plan on using [Usenet](https://www.reddit.com/r/usenet/wiki/faq#wiki_usen ## ii. BitTorrent -If you plan on using torrents with Saltbox, we recommend you have access to a [private torrent tracker](https://www.reddit.com/r/trackers/wiki/getting_into_private_trackers) as most servers don't allow public ones. However, if you still want to use public torrent trackers with Saltbox, you are free to do so. You will need to make some changes to the configuration to [allow access to public trackers](../faq/ruTorrent.md?h=public#enable-access-to-public-torrent-trackers), as they are blocked by default. +If you plan on using torrents with Saltbox, we recommend you have access to a [private torrent tracker](https://www.reddit.com/r/trackers/wiki/getting_into_private_trackers) as most servers don't allow public ones. However, if you still want to use public torrent trackers with Saltbox, you are free to do so. You will need to make some changes to the configuration to [allow access to public trackers](../faq/rutorrent.md?h=public#enable-access-to-public-torrent-trackers), as they are blocked by default. From 11eeb44ff4ad2fe1188eecee3e1feb7628dea8f0 Mon Sep 17 00:00:00 2001 From: owine Date: Mon, 14 Jul 2025 13:42:56 -0500 Subject: [PATCH 07/16] Fix file naming and admonition formatting consistency --- docs/apps/autobrr.md | 2 +- docs/apps/bazarr.md | 2 +- docs/apps/lidarr.md | 2 +- docs/apps/mariadb.md | 2 +- docs/apps/plex.md | 4 ++-- docs/apps/postgres.md | 2 +- docs/apps/qbittorrent.md | 4 ++-- docs/apps/radarr.md | 2 +- docs/apps/readarr.md | 2 +- docs/apps/sonarr.md | 2 +- docs/apps/whisparr.md | 2 +- docs/faq/{Bazarr.md => bazarr.md} | 0 docs/faq/{Cloudflare.md => cloudflare.md} | 0 docs/faq/{Cloudplow.md => cloudplow.md} | 0 docs/faq/{Docker.md => docker.md} | 0 docs/faq/{Hetzner.md => hetzner.md} | 0 docs/faq/{Install.md => install.md} | 0 docs/faq/{Misc.md => misc.md} | 0 docs/faq/{Plex.md => plex.md} | 0 docs/faq/{Rclone.md => rclone.md} | 0 docs/faq/{System.md => system.md} | 0 docs/reference/{OVH.md => ovh.md} | 0 docs/reference/rclone-manual.md | 2 +- docs/saltbox/backup/migrate.md | 4 ++-- docs/saltbox/basics/accessing-apps.md | 2 +- docs/sandbox/apps/adminer.md | 2 +- docs/sandbox/apps/audiobookshelf.md | 2 +- docs/sandbox/apps/cherry.md | 2 +- docs/sandbox/apps/codex.md | 2 +- docs/sandbox/apps/comixed.md | 2 +- docs/sandbox/apps/dashy.md | 2 +- docs/sandbox/apps/doplarr.md | 2 +- docs/sandbox/apps/elasticsearch.md | 2 +- docs/sandbox/apps/forgejo.md | 2 +- docs/sandbox/apps/foundry.md | 2 +- docs/sandbox/apps/gaps.md | 2 +- docs/sandbox/apps/handbrake.md | 2 +- docs/sandbox/apps/homarr.md | 2 +- docs/sandbox/apps/homeassistant.md | 2 +- docs/sandbox/apps/homebox.md | 2 +- docs/sandbox/apps/homepage.md | 2 +- docs/sandbox/apps/jellyseerr.md | 2 +- docs/sandbox/apps/joplin.md | 2 +- docs/sandbox/apps/lunasea.md | 2 +- docs/sandbox/apps/makemkv.md | 2 +- docs/sandbox/apps/mealie.md | 2 +- docs/sandbox/apps/minecraft-bedrock.md | 4 ++-- docs/sandbox/apps/minecraft.md | 2 +- docs/sandbox/apps/mylar3.md | 2 +- docs/sandbox/apps/paperless-ngx.md | 4 ++-- docs/sandbox/apps/pgadmin.md | 2 +- docs/sandbox/apps/photoprism.md | 2 +- docs/sandbox/apps/phpmyadmin.md | 2 +- docs/sandbox/apps/plex-dupefinder.md | 2 +- docs/sandbox/apps/puddletag.md | 2 +- docs/sandbox/apps/tandoor.md | 2 +- docs/sandbox/apps/tdarr.md | 2 +- docs/sandbox/apps/tqm.md | 6 ++--- docs/sandbox/apps/trackarr.md | 2 +- docs/sandbox/apps/tubearchivist.md | 2 +- docs/sandbox/apps/tvheadend.md | 2 +- .../sandbox/apps/unifi-network-application.md | 4 ++-- docs/sandbox/apps/vaultwarden.md | 2 +- docs/sandbox/basics.md | 2 +- mkdocs.yml | 22 +++++++++---------- 65 files changed, 72 insertions(+), 72 deletions(-) rename docs/faq/{Bazarr.md => bazarr.md} (100%) rename docs/faq/{Cloudflare.md => cloudflare.md} (100%) rename docs/faq/{Cloudplow.md => cloudplow.md} (100%) rename docs/faq/{Docker.md => docker.md} (100%) rename docs/faq/{Hetzner.md => hetzner.md} (100%) rename docs/faq/{Install.md => install.md} (100%) rename docs/faq/{Misc.md => misc.md} (100%) rename docs/faq/{Plex.md => plex.md} (100%) rename docs/faq/{Rclone.md => rclone.md} (100%) rename docs/faq/{System.md => system.md} (100%) rename docs/reference/{OVH.md => ovh.md} (100%) diff --git a/docs/apps/autobrr.md b/docs/apps/autobrr.md index 14386012a..8a33d224f 100644 --- a/docs/apps/autobrr.md +++ b/docs/apps/autobrr.md @@ -12,7 +12,7 @@ tags: [Autobrr](https://autobrr.com/) is a modern single binary replacement for the autodl-irssi+rutorrent plugin. autobrr monitors IRC announce channels and torznab RSS feeds to get releases as soon as they are available, with good filtering, and regex support. Go brr. -!!! Note +!!! note 📢 Work in progress. Expect bugs and breaking changes. Features may be broken or incomplete. | Details | | | diff --git a/docs/apps/bazarr.md b/docs/apps/bazarr.md index 54cdf8355..adddaa3e5 100644 --- a/docs/apps/bazarr.md +++ b/docs/apps/bazarr.md @@ -35,4 +35,4 @@ sb install bazarr There are some settings that - depending on your specific setup - should be adapted to reduce API calls down to a managable level. -Please refer to the official documentation for an explanation of the settings. Some - potentially out of date(!) - settings are documented in the [FAQs](../faq/Bazarr.md). +Please refer to the official documentation for an explanation of the settings. Some - potentially out of date(!) - settings are documented in the [FAQs](../faq/bazarr.md). diff --git a/docs/apps/lidarr.md b/docs/apps/lidarr.md index bd4d06d4f..f12ac8e6a 100644 --- a/docs/apps/lidarr.md +++ b/docs/apps/lidarr.md @@ -25,7 +25,7 @@ Click on "Settings" in the sidebar. Click "Show Advanced" at the top of the Set Make changes in the following sections: -!!! Settings +!!! info "Settings" === "Media Management" diff --git a/docs/apps/mariadb.md b/docs/apps/mariadb.md index b7b5a85bb..427e8f972 100644 --- a/docs/apps/mariadb.md +++ b/docs/apps/mariadb.md @@ -25,7 +25,7 @@ sb install mariadb ### 2. Setup -!!!info +!!! info The default password for this container is `password321` To easily manage the db, consider [adminer](../sandbox/apps/adminer.md) diff --git a/docs/apps/plex.md b/docs/apps/plex.md index 56f36f1d2..760fdf5d7 100644 --- a/docs/apps/plex.md +++ b/docs/apps/plex.md @@ -42,7 +42,7 @@ tags: ![](../images/plex-media-server/plex-05-server-setup-3.png) -!!! Settings +!!! info "Settings" === "Library" @@ -160,7 +160,7 @@ In this section, we will add two libraries: one for Movies and one for TV. _Note: If you would like to have custom Plex libraries (more than just a Movies and TV one), see [Customizing Plex Libraries](../reference/customizing-plex-libs.md)._ -!!! Libraries +!!! info "Libraries" === "Add the Movie Library" diff --git a/docs/apps/postgres.md b/docs/apps/postgres.md index 7fc00f033..4ac200d7e 100644 --- a/docs/apps/postgres.md +++ b/docs/apps/postgres.md @@ -25,7 +25,7 @@ sb install postgres ### 2. Setup -!!!info +!!! info The default password for this container is `password4321` To easily manage the db, consider [adminer](../sandbox/apps/adminer.md) diff --git a/docs/apps/qbittorrent.md b/docs/apps/qbittorrent.md index e05e96ee2..2cb515f3a 100644 --- a/docs/apps/qbittorrent.md +++ b/docs/apps/qbittorrent.md @@ -59,7 +59,7 @@ sb install qbittorrent ![Hard Disk Section Screenshot](../images/community/qbit_hdd.png) -!!! Warning +!!! warning Make sure to choose a strong username/password combination because by default qBittorrent's Web API is completely exposed to the internet! If someone guesses your qBit's credentials, they can, among other things, steal your tracker passkeys and delete torrents (data included). If you don't need the API endpoints exposed, you can disable them using the [inventory system](../saltbox/inventory/index.md) with @@ -71,7 +71,7 @@ sb install qbittorrent and by rerunning the `qbittorrent` tag. -!!! Note +!!! note if you're using private trackers be sure to go to `Options` -> `BitTorrent` and uncheck everything in Privacy section. - [:octicons-link-16: Documentation](https://github.com/qbittorrent/qBittorrent/wiki){: .header-icons } diff --git a/docs/apps/radarr.md b/docs/apps/radarr.md index c3ddd222b..777e73fd7 100644 --- a/docs/apps/radarr.md +++ b/docs/apps/radarr.md @@ -25,7 +25,7 @@ Click on "Settings" in the sidebar. Click "Show Advanced" at the top of the Set Make changes in the following sections: -!!! Settings +!!! info "Settings" === "Media Management" diff --git a/docs/apps/readarr.md b/docs/apps/readarr.md index 372e45f6f..3fb5ff525 100644 --- a/docs/apps/readarr.md +++ b/docs/apps/readarr.md @@ -14,7 +14,7 @@ tags: Note that only one type of a given book is supported.
**If you want both an audiobook and ebook of a given book you will need multiple instances.** -!!! NOTE +!!! note Readarr is currently in beta testing and is generally still in a work in progress. Features may be broken, incomplete, or cause spontaneous combustion. | Details | | | | diff --git a/docs/apps/sonarr.md b/docs/apps/sonarr.md index 9821ac133..181115228 100644 --- a/docs/apps/sonarr.md +++ b/docs/apps/sonarr.md @@ -25,7 +25,7 @@ Click on "Settings" in the sidebar. Click "Show Advanced" at the top of the Set Make changes in the following sections: -!!! Settings +!!! info "Settings" === "Media Management" diff --git a/docs/apps/whisparr.md b/docs/apps/whisparr.md index c80feca5e..b1cbc3da8 100644 --- a/docs/apps/whisparr.md +++ b/docs/apps/whisparr.md @@ -11,7 +11,7 @@ tags: [Whisparr](https://wiki.servarr.com/whisparr) is an adult movie collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new movies and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available. Note that only one type of a given movie is supported. If you want both an 4k version and 1080p version of a given movie you will need multiple instances. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into whisparr with the email and password you set up upon installation. | Details | | | | diff --git a/docs/faq/Bazarr.md b/docs/faq/bazarr.md similarity index 100% rename from docs/faq/Bazarr.md rename to docs/faq/bazarr.md diff --git a/docs/faq/Cloudflare.md b/docs/faq/cloudflare.md similarity index 100% rename from docs/faq/Cloudflare.md rename to docs/faq/cloudflare.md diff --git a/docs/faq/Cloudplow.md b/docs/faq/cloudplow.md similarity index 100% rename from docs/faq/Cloudplow.md rename to docs/faq/cloudplow.md diff --git a/docs/faq/Docker.md b/docs/faq/docker.md similarity index 100% rename from docs/faq/Docker.md rename to docs/faq/docker.md diff --git a/docs/faq/Hetzner.md b/docs/faq/hetzner.md similarity index 100% rename from docs/faq/Hetzner.md rename to docs/faq/hetzner.md diff --git a/docs/faq/Install.md b/docs/faq/install.md similarity index 100% rename from docs/faq/Install.md rename to docs/faq/install.md diff --git a/docs/faq/Misc.md b/docs/faq/misc.md similarity index 100% rename from docs/faq/Misc.md rename to docs/faq/misc.md diff --git a/docs/faq/Plex.md b/docs/faq/plex.md similarity index 100% rename from docs/faq/Plex.md rename to docs/faq/plex.md diff --git a/docs/faq/Rclone.md b/docs/faq/rclone.md similarity index 100% rename from docs/faq/Rclone.md rename to docs/faq/rclone.md diff --git a/docs/faq/System.md b/docs/faq/system.md similarity index 100% rename from docs/faq/System.md rename to docs/faq/system.md diff --git a/docs/reference/OVH.md b/docs/reference/ovh.md similarity index 100% rename from docs/reference/OVH.md rename to docs/reference/ovh.md diff --git a/docs/reference/rclone-manual.md b/docs/reference/rclone-manual.md index 2a86a10cb..310a34f3c 100644 --- a/docs/reference/rclone-manual.md +++ b/docs/reference/rclone-manual.md @@ -247,7 +247,7 @@ To rename the Google Drive remote to `google`: cp -n $(rclone config file | tail -n 1) ~/.config/rclone/rclone.conf ``` -1. Give it the proper ownership and permissions. Replace `user` and `group` to match yours (see [here](../faq/System.md#find-your-user-id-uid-and-group-id-gid)): +1. Give it the proper ownership and permissions. Replace `user` and `group` to match yours (see [here](../faq/system.md#find-your-user-id-uid-and-group-id-gid)): ```shell sudo chown user:group ~/.config/rclone/rclone.conf diff --git a/docs/saltbox/backup/migrate.md b/docs/saltbox/backup/migrate.md index 8ef63729a..4e489bdf6 100644 --- a/docs/saltbox/backup/migrate.md +++ b/docs/saltbox/backup/migrate.md @@ -49,7 +49,7 @@ Listed below are some common scenarios and their migration instructions. 3. If you are using Cloudflare: - 1. Register your domain with [Cloudflare](../../faq/Cloudflare.md). + 1. Register your domain with [Cloudflare](../../faq/cloudflare.md). 2. Add the Cloudflare API into [Accounts](../install/install.md#step-2-configuration). @@ -83,7 +83,7 @@ Listed below are some common scenarios and their migration instructions. 3. If you are using Cloudflare: - 1. Register your domain with [Cloudflare](../../faq/Cloudflare.md). + 1. Register your domain with [Cloudflare](../../faq/cloudflare.md). 2. Add the Cloudflare API into [Accounts](../install/install.md#step-2-configuration). diff --git a/docs/saltbox/basics/accessing-apps.md b/docs/saltbox/basics/accessing-apps.md index 0470cdf1c..bf9442e9a 100644 --- a/docs/saltbox/basics/accessing-apps.md +++ b/docs/saltbox/basics/accessing-apps.md @@ -9,7 +9,7 @@ tags: # Accessing Saltbox Apps -_Note 1: If pages don't load at all, make sure you've set up your [domain](../../reference/domain.md) properly and also checkout the [FAQ](../../faq/System.md)._ +_Note 1: If pages don't load at all, make sure you've set up your [domain](../../reference/domain.md) properly and also checkout the [FAQ](../../faq/system.md)._ ## Default Apps diff --git a/docs/sandbox/apps/adminer.md b/docs/sandbox/apps/adminer.md index 7ea5f3a8a..28f87bcc5 100644 --- a/docs/sandbox/apps/adminer.md +++ b/docs/sandbox/apps/adminer.md @@ -13,7 +13,7 @@ tags: [Adminer](https://www.adminer.org/) Adminer (formerly phpMinAdmin) is a full-featured database management tool written in PHP. Adminer is available for MySQL, MariaDB, PostgreSQL, SQLite, MS SQL, Oracle, Elasticsearch, MongoDB and others via plugin. -!!!info "Protected Role" +!!! info "Protected Role" By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/audiobookshelf.md b/docs/sandbox/apps/audiobookshelf.md index 2adc05478..f3f57ec98 100644 --- a/docs/sandbox/apps/audiobookshelf.md +++ b/docs/sandbox/apps/audiobookshelf.md @@ -13,7 +13,7 @@ tags: [audiobookshelf](https://www.audiobookshelf.org/) is a self-hosted audio book and podcast server. -!!!info +!!! info By default, the role is NOT protected behind your Authelia/SSO middleware. | Details | | | | diff --git a/docs/sandbox/apps/cherry.md b/docs/sandbox/apps/cherry.md index 71899400e..e47d5fd29 100644 --- a/docs/sandbox/apps/cherry.md +++ b/docs/sandbox/apps/cherry.md @@ -19,7 +19,7 @@ tags: - It has a simple UI. But you got all the features you want for a bookmark service. Tags, groups, full text search and browser extensions. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | diff --git a/docs/sandbox/apps/codex.md b/docs/sandbox/apps/codex.md index d7c21165a..a1578282f 100644 --- a/docs/sandbox/apps/codex.md +++ b/docs/sandbox/apps/codex.md @@ -27,7 +27,7 @@ tags: - Add custom covers to Folders, Publishers, Imprints, Series, and Story Arcs. - Runs in 1GB of RAM, faster with more. -!!!info +!!! info By default, the role is **NOT** protected behind your Authelia/SSO middleware. You will have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/comixed.md b/docs/sandbox/apps/comixed.md index 1dfcad125..99d563a66 100644 --- a/docs/sandbox/apps/comixed.md +++ b/docs/sandbox/apps/comixed.md @@ -41,7 +41,7 @@ sb install sandbox-comixed ### 3. Setup -!!!info +!!! info 📢 ComiXed has 2 default users created when you run the role. It is a good idea to change the passwords for each account from the default asap. ``` shell diff --git a/docs/sandbox/apps/dashy.md b/docs/sandbox/apps/dashy.md index e37ff3637..339c80f9c 100644 --- a/docs/sandbox/apps/dashy.md +++ b/docs/sandbox/apps/dashy.md @@ -30,7 +30,7 @@ tags: - **Customizable Layouts** - Structure your dashboard to fit your use case. From the UI, you can choose between different layouts, item sizes, show/ hide components, switch themes plus more. You can customize pretty much every area of your dashboard. There are config options for custom header, footer, nav bar links, title etc. You can also choose to hide any elements you don't need. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/doplarr.md b/docs/sandbox/apps/doplarr.md index 35941b0fd..f00a3f792 100644 --- a/docs/sandbox/apps/doplarr.md +++ b/docs/sandbox/apps/doplarr.md @@ -70,7 +70,7 @@ sb install sandbox-doplarr ``` -!!! Note +!!! note 📢 You may also override the default setting of Doplarr working with overseer, to work with Sonarr and Radarr. The recommended way to customize these parameters is to use the [inventory](../../saltbox/inventory/index.md). You should edit `/srv/git/saltbox/inventories/host_vars/localhost.yml` and add the following section. diff --git a/docs/sandbox/apps/elasticsearch.md b/docs/sandbox/apps/elasticsearch.md index 438d4a3d2..dec7fb285 100644 --- a/docs/sandbox/apps/elasticsearch.md +++ b/docs/sandbox/apps/elasticsearch.md @@ -13,7 +13,7 @@ tags: [Elasticsearch](https://www.elastic.co/elasticsearch) is an open source distributed, RESTful search and analytics engine, scalable data store, and vector database capable of addressing a growing number of use cases. As the heart of the Elastic Stack, it centrally stores your data for lightning-fast search, fine‑tuned relevancy, and powerful analytics that scale with ease. -!!!info +!!! info Elasticsearch is typically not a standalone app, it is run in tandem with another role to enable features. | Details | | | | diff --git a/docs/sandbox/apps/forgejo.md b/docs/sandbox/apps/forgejo.md index 4a1552f66..d6182e0b8 100644 --- a/docs/sandbox/apps/forgejo.md +++ b/docs/sandbox/apps/forgejo.md @@ -21,7 +21,7 @@ Easy to install and low maintenance, it just does the job. - **Guaranteed 100% Free Software**: Forgejo will always be Free and Open Source Software. Furthermore we exclusively use Free Software for our own project development. - **Beyond coding, we forge ahead**: An exciting future awaits. We will innovate the Software Forge and enable collaborative software development facilitated by decentralized platforms. -!!!info +!!! info By default, the role is **NOT** protected behind your Authelia/SSO middleware. You have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/foundry.md b/docs/sandbox/apps/foundry.md index fa7107d4c..24f661e37 100644 --- a/docs/sandbox/apps/foundry.md +++ b/docs/sandbox/apps/foundry.md @@ -16,7 +16,7 @@ Foundry VTT provides the full set of digital tools necessary to emulate and (and While other VTTs can provide some of these basic elements, the Foundry team prides ourselves on continually pushing the boundaries of the possible, providing rich dynamic lighting/fog of war, immersive audio, interactive map regions, powerful modding capabilities, and much more. Foundry VTT gives you everything you need (and then some) to forge thrilling and memorable moments with your gaming group! -!!!info +!!! info By default, the role is **NOT** protected behind your Authelia/SSO middleware. You will have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/gaps.md b/docs/sandbox/apps/gaps.md index b7e28f1ec..e346bd03f 100644 --- a/docs/sandbox/apps/gaps.md +++ b/docs/sandbox/apps/gaps.md @@ -13,7 +13,7 @@ tags: [Gaps](https://github.com/JasonHHouse/gaps) searches through your Plex Server for all movies, then queries for known movies in the same collection. If those movies don't exist in your library, Gaps will recommend getting those movies, legally of course. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will NOT have to log into the app itself, as basic Auth is disabled by default. | Details | | | | diff --git a/docs/sandbox/apps/handbrake.md b/docs/sandbox/apps/handbrake.md index df525e343..41ebd5913 100644 --- a/docs/sandbox/apps/handbrake.md +++ b/docs/sandbox/apps/handbrake.md @@ -51,5 +51,5 @@ sb install sandbox-handbrake 4. See the HandBrake documentation for usage: - [:octicons-link-16: Documentation](https://handbrake.fr/docs){: .header-icons } -!!! Tip +!!! tip This container has an automatic video converter built in, see the [container documentation here](https://github.com/jlesage/docker-handbrake#automatic-video-conversion){: .header-icons }. diff --git a/docs/sandbox/apps/homarr.md b/docs/sandbox/apps/homarr.md index a2f1b9390..d944ec7ff 100644 --- a/docs/sandbox/apps/homarr.md +++ b/docs/sandbox/apps/homarr.md @@ -20,7 +20,7 @@ tags: - Automatically finds icons while you type the name of a service. - Widgets that can display all types of information. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/homeassistant.md b/docs/sandbox/apps/homeassistant.md index c8236f2ad..1f10fff4d 100644 --- a/docs/sandbox/apps/homeassistant.md +++ b/docs/sandbox/apps/homeassistant.md @@ -15,7 +15,7 @@ tags: Note that while it will work on a remote server, it takes some doing to get it to interface with a local server or local devices. It is not recommended or supported. -!!! Warning +!!! warning By default, the role is NOT protected behind your Authelia/SSO middleware. Home Assistant has its own authentication system (with 2FA), and it is recommended to use that. | Details | | | | diff --git a/docs/sandbox/apps/homebox.md b/docs/sandbox/apps/homebox.md index dc23b6d80..707d05f71 100644 --- a/docs/sandbox/apps/homebox.md +++ b/docs/sandbox/apps/homebox.md @@ -13,7 +13,7 @@ tags: [Homebox](https://homebox.software/en/) is the inventory and organization system built for the Home User! With a focus on simplicity and ease of use, Homebox is the perfect solution for your home inventory, organization, and management needs. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | diff --git a/docs/sandbox/apps/homepage.md b/docs/sandbox/apps/homepage.md index abe2eaf7c..8469e927c 100644 --- a/docs/sandbox/apps/homepage.md +++ b/docs/sandbox/apps/homepage.md @@ -24,7 +24,7 @@ tags: - Service integration - Sonarr, Radarr, Readarr, Prowlarr, Bazarr, Lidarr, Emby, Jellyfin, Tautulli, Plex and more -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. | Details | | | diff --git a/docs/sandbox/apps/jellyseerr.md b/docs/sandbox/apps/jellyseerr.md index 0644edad4..7bd1bfceb 100644 --- a/docs/sandbox/apps/jellyseerr.md +++ b/docs/sandbox/apps/jellyseerr.md @@ -26,7 +26,7 @@ tags: - Mobile-friendly design, for when you need to approve requests on the go! - Support for watchlisting & blacklisting media. -!!!info +!!! info By default, the role is **NOT** protected behind your Authelia/SSO middleware. You will have to log in with Plex, Jellyfin, etc. Make the appropriate changes via inventory to add SSO. | Details | | | | diff --git a/docs/sandbox/apps/joplin.md b/docs/sandbox/apps/joplin.md index b08ef90ed..97052cd76 100644 --- a/docs/sandbox/apps/joplin.md +++ b/docs/sandbox/apps/joplin.md @@ -31,7 +31,7 @@ sb install sandbox-joplin ### 3. Setup -!!!info +!!! info Default login for joplin is `email: admin@localhost` `password: admin` diff --git a/docs/sandbox/apps/lunasea.md b/docs/sandbox/apps/lunasea.md index 96c1a611c..c9b7e45a8 100644 --- a/docs/sandbox/apps/lunasea.md +++ b/docs/sandbox/apps/lunasea.md @@ -18,7 +18,7 @@ tags: - Manage your queue in usenet binary newsreaders, including SABnzbd and NZBGet. - Search newsgroup indexers and send NZBs directly to your binary newsreaders. -!!!info +!!! info By default, the role **IS** protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | diff --git a/docs/sandbox/apps/makemkv.md b/docs/sandbox/apps/makemkv.md index f168f9274..94e6d76ba 100644 --- a/docs/sandbox/apps/makemkv.md +++ b/docs/sandbox/apps/makemkv.md @@ -13,7 +13,7 @@ tags: [MakeMKV](http://www.makemkv.com/) is your one-click solution to convert video that you own into free and patents-unencumbered format that can be played everywhere. MakeMKV is a format converter, otherwise called "transcoder". It converts the video clips from proprietary (and usually encrypted) disc into a set of MKV files, preserving most information but not changing it in any way. The MKV format can store multiple video/audio tracks with all meta-information and preserve chapters. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. | Details | | | | diff --git a/docs/sandbox/apps/mealie.md b/docs/sandbox/apps/mealie.md index 987c03316..0f1a03a19 100644 --- a/docs/sandbox/apps/mealie.md +++ b/docs/sandbox/apps/mealie.md @@ -13,7 +13,7 @@ tags: [Mealie](https://mealie.io/) is aan intuitive and easy to use recipe management app. It's designed to make your life easier by being the best recipes management experience on the web and providing you with an easy to use interface to manage your growing collection of recipes. -!!!info +!!! info By default, the role is **NOT** protected behind your Authelia/SSO middleware. You have to log into the role itself. | Details | | | | diff --git a/docs/sandbox/apps/minecraft-bedrock.md b/docs/sandbox/apps/minecraft-bedrock.md index 7eeaad4b5..71e3668e7 100644 --- a/docs/sandbox/apps/minecraft-bedrock.md +++ b/docs/sandbox/apps/minecraft-bedrock.md @@ -9,7 +9,7 @@ tags: [Minecraft Bedrock](https://github.com/itzg/docker-minecraft-bedrock-server) is a server for the multi-platform version of Minecraft. -!!! Note +!!! note 📢 This server will expose the port UDP 19132 | Details | | | | @@ -28,7 +28,7 @@ sb install sandbox-minecraft-bedrock - The server will be accessible at `minecraft-bedrock._yourdomain.com_` or `_yourserverip_:19132` -!!! Warning "Cloudflare CDN" +!!! warning "Cloudflare CDN" If you are using Cloudflare, you will need to disable the proxy for the subdomain(s) to work correctly. This can be done by clicking the orange cloud next to the subdomain in the DNS settings. Or specify it in the inventory using `minecraft-bedrock_dns_proxy: false` if you have the global toggle on. Otherwise you won't be able to reach the minecraft server at all. ### Change server version diff --git a/docs/sandbox/apps/minecraft.md b/docs/sandbox/apps/minecraft.md index 3b74010fd..c4827628f 100644 --- a/docs/sandbox/apps/minecraft.md +++ b/docs/sandbox/apps/minecraft.md @@ -25,7 +25,7 @@ This will install [mc-router](../apps/mcrouter.md) and the minecraft server. If ### 2. Join Server -!!! Warning "Cloudflare CDN" +!!! warning "Cloudflare CDN" If you are using Cloudflare, you will need to disable the proxy for the subdomain(s) to work correctly. This can be done by clicking the orange cloud next to the subdomain in the DNS settings. Or specify it in the inventory using `minecraft_dns_proxy: false` if you have the global toggle on. Otherwise you won't be able to reach the minecraft server at all. - By default, a single server will be accesible at `minecraft._yourdomain.com_` diff --git a/docs/sandbox/apps/mylar3.md b/docs/sandbox/apps/mylar3.md index c754c4c5b..061e9a495 100644 --- a/docs/sandbox/apps/mylar3.md +++ b/docs/sandbox/apps/mylar3.md @@ -50,7 +50,7 @@ sb install sandbox-mylar3 8. Save and then restart the app -!!! Note +!!! note If you enable to OPDS server, DO NOT ENABLE `OPDS Fetch MetaInfo`. It queries the file system. ### Download settings diff --git a/docs/sandbox/apps/paperless-ngx.md b/docs/sandbox/apps/paperless-ngx.md index c5af2f90a..cb4b80969 100644 --- a/docs/sandbox/apps/paperless-ngx.md +++ b/docs/sandbox/apps/paperless-ngx.md @@ -15,7 +15,7 @@ tags: Paperless-NGX is forked from paperless-ng to continue the great work and distribute responsibility of supporting and advancing the project among a team of people. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. | Details | | | | @@ -36,7 +36,7 @@ sb install sandbox-paperless-ngx ### 3. Setup -!!!info +!!! info Please refer to [this](https://github.com/saltyorg/docs/issues/116#issuecomment-1278733921) comment on the initial PR for questions about google storage! - [:octicons-link-16: Documentation: Paperless NGX Docs](https://paperless-ngx.readthedocs.io/en/latest/index.html){: .header-icons } diff --git a/docs/sandbox/apps/pgadmin.md b/docs/sandbox/apps/pgadmin.md index f72bdea00..aac22f2f0 100644 --- a/docs/sandbox/apps/pgadmin.md +++ b/docs/sandbox/apps/pgadmin.md @@ -13,7 +13,7 @@ tags: [pgadmin](https://www.pgadmin.org/) is a popular and feature rich Open Source administration and development platform for PostgreSQL. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/photoprism.md b/docs/sandbox/apps/photoprism.md index 2d7beba52..22e1bfb93 100644 --- a/docs/sandbox/apps/photoprism.md +++ b/docs/sandbox/apps/photoprism.md @@ -13,7 +13,7 @@ tags: [Photoprism®](https://photoprism.app/) is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. Note: This is not a multi-user app. | Details | | | | diff --git a/docs/sandbox/apps/phpmyadmin.md b/docs/sandbox/apps/phpmyadmin.md index f6e44ed17..4b2f8eab5 100644 --- a/docs/sandbox/apps/phpmyadmin.md +++ b/docs/sandbox/apps/phpmyadmin.md @@ -29,7 +29,7 @@ tags: - Searching globally in a database or a subset of it - Transforming stored data into any format using a set of predefined functions, like displaying BLOB-data as image or download-link -!!!info +!!! info By default, the role **IS** protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/plex-dupefinder.md b/docs/sandbox/apps/plex-dupefinder.md index b9308af58..8dbaaacee 100644 --- a/docs/sandbox/apps/plex-dupefinder.md +++ b/docs/sandbox/apps/plex-dupefinder.md @@ -15,7 +15,7 @@ tags: - Duplicates can be either in bulk (automatic) or one-by-one (interactively). -!!! Note +!!! note 📢 You will need to have `allow media deletion: enabled` ticked. [here](https://github.com/l3uddz/plex_dupefinder#plex) | Details | | | diff --git a/docs/sandbox/apps/puddletag.md b/docs/sandbox/apps/puddletag.md index 7119c3cad..89c1539ad 100644 --- a/docs/sandbox/apps/puddletag.md +++ b/docs/sandbox/apps/puddletag.md @@ -13,7 +13,7 @@ tags: [Puddletag](https://docs.puddletag.net/) is an audio tag editor (primarily created) for GNU/Linux similar to the Windows program, Mp3tag. Unlike most taggers for GNU/Linux, it uses a spreadsheet-like layout so that all the tags you want to edit by hand are visible and easily editable. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. (Basic Auth) | Details | | | diff --git a/docs/sandbox/apps/tandoor.md b/docs/sandbox/apps/tandoor.md index f09d9a2b2..46866d4d2 100644 --- a/docs/sandbox/apps/tandoor.md +++ b/docs/sandbox/apps/tandoor.md @@ -25,7 +25,7 @@ tags: - 👪 Share and collaborate on recipes with friends and family -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/tdarr.md b/docs/sandbox/apps/tdarr.md index 83ca69cd0..6b57e073a 100644 --- a/docs/sandbox/apps/tdarr.md +++ b/docs/sandbox/apps/tdarr.md @@ -13,7 +13,7 @@ tags: [Tdarr](https://tdarr.io/) is a cross-platform conditional based transcoding application for automating media library transcode/remux management in order to process your media files as required. For example, you can set rules for the required codecs, containers, languages etc that your media should have which helps keeps things organized and can increase compatability with your devices. A common use for Tdarr is to simply convert video files from h264 to h265 (hevc), saving 40%-50% in size. -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. | Details | | | | diff --git a/docs/sandbox/apps/tqm.md b/docs/sandbox/apps/tqm.md index 58344eb2f..b6f1a39f1 100644 --- a/docs/sandbox/apps/tqm.md +++ b/docs/sandbox/apps/tqm.md @@ -15,7 +15,7 @@ tags: - The tqm binary is downloaded and a service and timer file created when the config is identified. -!!! Note +!!! note 📢 You will need to have `config.yaml` in place (`/opt/tqm/`) for the role to run successfully. [Here](https://github.com/autobrr/tqm#example-configuration) is an example config you can grab and fill in with your own details. | Details | @@ -36,7 +36,7 @@ nano /opt/tqm/config.yaml ### Modify "Client" section -!!! Note +!!! note 📢 As setup for Saltbox, tqm uses this path to find your downloaded files: `/mnt/unionfs/downloads/...` (see [Paths](../../saltbox/basics/paths.md#media)) Client Example: @@ -139,7 +139,7 @@ Label Example: ``` -!!! Note +!!! note 📢 tqm will not create a category for you, so be sure to create the category first. If you want the file moved as well, you will need to set **Default Torrent Management Mode: Automatic**. diff --git a/docs/sandbox/apps/trackarr.md b/docs/sandbox/apps/trackarr.md index 291ccbcdf..d808810f3 100644 --- a/docs/sandbox/apps/trackarr.md +++ b/docs/sandbox/apps/trackarr.md @@ -13,7 +13,7 @@ tags: [Trackarr](https://gitlab.com/cloudb0x/trackarr) monitors tracker announce IRC channel, parses the announcements, and forwards those announcements to ARR PVRs (eg Sonarr/Radarr). -!!!info +!!! info By default, the role is **NOT** protected behind your Authelia/SSO middleware. You will have to log into the app itself (basic auth). | Details | | | | diff --git a/docs/sandbox/apps/tubearchivist.md b/docs/sandbox/apps/tubearchivist.md index 813bd864f..6ba65cf86 100644 --- a/docs/sandbox/apps/tubearchivist.md +++ b/docs/sandbox/apps/tubearchivist.md @@ -19,7 +19,7 @@ tags: - Play videos - Keep track of viewed and unviewed videos -!!!info +!!! info By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/tvheadend.md b/docs/sandbox/apps/tvheadend.md index 0b2d28b20..0d0877323 100644 --- a/docs/sandbox/apps/tvheadend.md +++ b/docs/sandbox/apps/tvheadend.md @@ -31,7 +31,7 @@ HTTP HTSP (own protocol) SAT>IP -!!!info +!!! info By default, the role **IS** protected behind your Authelia/SSO middleware. You will also have to log into the app itself. | Details | | | | diff --git a/docs/sandbox/apps/unifi-network-application.md b/docs/sandbox/apps/unifi-network-application.md index 699cd7671..eadeb0b13 100644 --- a/docs/sandbox/apps/unifi-network-application.md +++ b/docs/sandbox/apps/unifi-network-application.md @@ -17,7 +17,7 @@ tags: |-------------|-------------|-------------|-------------| | [:material-home: Project home](https://www.ui.com/download/unifi/){: .header-icons } | [:octicons-link-16: Docs](https://github.com/linuxserver/docker-unifi-network-application/blob/main/README.md){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/linuxserver/docker-unifi-network-application){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/linuxserver/unifi-network-application){: .header-icons }| -!!! Warning +!!! warning This role is a replacement for the previous Unifi Controller role. This is not an in-place replacement. In order to migrate, you must perform a full backup from the Unifi web interface, and restore from that backup when running the setup wizard in a fresh instance of the Unifi Network Application. You must rename/remove the previous appdata from `/opt/unifi` before deploying the Unifi Network Application role. ### 1. Installation @@ -51,7 +51,7 @@ sb install sandbox-unifi-network-application - [:octicons-link-16: Documentation: Unifi Net App Docs](https://github.com/linuxserver/docker-unifi-network-application/blob/master/README.md){: .header-icons } -!!! Note +!!! note 📢 The default setup only publish the 8080 tcp port, which is the bare minimum to allow communication between your network equipment and Unifi Network Application. Depending on your requirements, you may need additional ports according to the [:octicons-link-16: Documentation](https://github.com/linuxserver/docker-unifi-network-application#parameters) . diff --git a/docs/sandbox/apps/vaultwarden.md b/docs/sandbox/apps/vaultwarden.md index c7605ade3..99df17043 100644 --- a/docs/sandbox/apps/vaultwarden.md +++ b/docs/sandbox/apps/vaultwarden.md @@ -13,7 +13,7 @@ tags: [vaultwarden](https://github.com/dani-garcia/vaultwarden) is an alternative implementation of the Bitwarden server API written in Rust and compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal. -!!! Note +!!! note 📢 This project was known as Bitwarden_RS and has been renamed to separate itself from the official Bitwarden server in the hopes of avoiding confusion and trademark/branding issues. | Details | | | | diff --git a/docs/sandbox/basics.md b/docs/sandbox/basics.md index e8c002015..709a939a0 100644 --- a/docs/sandbox/basics.md +++ b/docs/sandbox/basics.md @@ -65,7 +65,7 @@ sb list ``` -!!! Tip +!!! tip Where possible the configured username/password are taken from your Saltbox [`accounts.yml`](../saltbox/install/install.md#step-2-configuration) file located in `/srv/git/saltbox/accounts.yml` and used to create a default user an password for logging in. ### Requesting Sandbox Apps diff --git a/mkdocs.yml b/mkdocs.yml index ee7790da3..2c27fca49 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -428,20 +428,20 @@ nav: - Plex-DB: apps/utility_tags/plex-db.md - FAQ: - - System: faq/System.md + - System: faq/system.md - Cloud Storage: faq/cloud-storage.md - - CloudFlare: faq/Cloudflare.md - - Cloudplow: faq/Cloudplow.md - - Docker: faq/Docker.md - - Hetzner & Google IPv6: faq/Hetzner.md - - Install: faq/Install.md + - CloudFlare: faq/cloudflare.md + - Cloudplow: faq/cloudplow.md + - Docker: faq/docker.md + - Hetzner & Google IPv6: faq/hetzner.md + - Install: faq/install.md - Backup and Restore: faq/backup-and-restore.md - - Rclone: faq/Rclone.md - - Plex: faq/Plex.md + - Rclone: faq/rclone.md + - Plex: faq/plex.md - ruTorrent: faq/rutorrent.md - - Misc: faq/Misc.md + - Misc: faq/misc.md - sb: faq/sb.md - - Bazarr: faq/Bazarr.md + - Bazarr: faq/bazarr.md - Advanced: - Index: advanced/index.md @@ -532,4 +532,4 @@ nav: - Adding a Subdomain: reference/subdomain.md - Using Local Storage: reference/local-storage.md - Mounting disks: reference/guides/mount.md - - HW transcoding on OVH: reference/OVH.md + - HW transcoding on OVH: reference/ovh.md From b3fbc9a659ee90164b93e80ab076542aa3f12b30 Mon Sep 17 00:00:00 2001 From: owine Date: Mon, 14 Jul 2025 13:46:28 -0500 Subject: [PATCH 08/16] Fix list formatting and code block language consistency --- docs/advanced/crowdsec.md | 2 +- docs/advanced/styled-error-pages.md | 4 +-- docs/advanced/user-crontab-examples.md | 16 ++++++------ docs/apps/asshama.md | 32 +++++++++++------------ docs/apps/autoscan.md | 8 +++--- docs/apps/cloudplow.md | 6 ++--- docs/apps/emby.md | 2 +- docs/apps/rutorrent.md | 2 +- docs/apps/sabnzbd.md | 2 +- docs/faq/hetzner.md | 4 +-- docs/faq/system.md | 2 +- docs/reference/google-service-accounts.md | 2 +- docs/reference/guides/other.md | 2 +- docs/reference/guides/tautuliscripts.md | 2 +- docs/reference/plex_auth_token.md | 4 +-- 15 files changed, 45 insertions(+), 45 deletions(-) diff --git a/docs/advanced/crowdsec.md b/docs/advanced/crowdsec.md index 9cf77a76a..613597bcb 100644 --- a/docs/advanced/crowdsec.md +++ b/docs/advanced/crowdsec.md @@ -123,7 +123,7 @@ So any changes to these will be lost next time the role runs. Example: -```bash +```shell sb install crowdsec ``` diff --git a/docs/advanced/styled-error-pages.md b/docs/advanced/styled-error-pages.md index 25c485689..35bd4a722 100644 --- a/docs/advanced/styled-error-pages.md +++ b/docs/advanced/styled-error-pages.md @@ -62,13 +62,13 @@ These error pages do not work with every app; do your own a/b testing to verify You can find the Saltbox roles that are known to NOT work with: -```bash +```shell grep -Ril "_traefik_error_pages_enabled: false" /srv/git/saltbox/roles | cut -d/ -f6 | sort -u ``` You can find the Sandbox roles that are known to NOT work with: -```bash +```shell grep -Ril "_traefik_error_pages_enabled: false" /opt/sandbox/roles | cut -d/ -f5 | sort -u ``` diff --git a/docs/advanced/user-crontab-examples.md b/docs/advanced/user-crontab-examples.md index ae6586c63..8476690cc 100644 --- a/docs/advanced/user-crontab-examples.md +++ b/docs/advanced/user-crontab-examples.md @@ -19,7 +19,7 @@ If you are unfamiliar with the syntax shown below, [crontab generator](https://c To edit your crontab, enter `crontab -e` -```bash +```shell PATH=/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin @daily cd /opt/plex-meta-manager && python plex-meta-manager.py -r 0 7 * * 7 sudo PATH='/usr/bin:/bin:/usr/local/bin' env ANSIBLE_CONFIG='/srv/git/saltbox/ansible.cfg' 'sb install backup' -v >> '/home/seed/logs/saltbox_backup.log' 2>&1 @@ -50,12 +50,12 @@ PATH=/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin This script deletes -* everything under a size of 100M -* every unwanted file immediately -* everything but the wanted files after 10 hours -* every empty folder +- everything under a size of 100M +- every unwanted file immediately +- everything but the wanted files after 10 hours +- every empty folder -```bash +```shell #!/bin/bash ##################################################### # script by pho @@ -135,7 +135,7 @@ eval "${command}" Note that this script is specific to its author's setup when it was written. It probably won't work for you as-is. You'll need to edit the paths to match your situation. -```Bash +```shell #!/bin/bash find /mnt/local/downloads/nzbget/completed/sonarr/* -type d -mmin +60 -ls -exec rm -rf {} + 2>/dev/null find /mnt/local/downloads/nzbget/completed/radarr/* -type d -mmin +60 -ls -exec rm -rf {} + 2>/dev/null @@ -149,7 +149,7 @@ find /mnt/local/downloads/nzbget/completed/anime/* -type d -mmin +60 -ls -exec r ### RXWatcher's optimize.sh -```bash +```shell #!/bin/sh # Get the contents of the Preferences file, keep only what we need, push to a temp, then use it in the curl command diff --git a/docs/apps/asshama.md b/docs/apps/asshama.md index 5ff098a76..d2b3cd807 100644 --- a/docs/apps/asshama.md +++ b/docs/apps/asshama.md @@ -13,25 +13,25 @@ tags: HAMA is a plex agent specifically for anime and its various challenges. It is recommended to use the HAMA agent with the Absolute Series Scanner (ASS). Hama agent features include: - -* Both Movies and Series Agent -* AniDB ID to TVDB/TMDB ID matching (with studio and episode mapping list) with ScudLee's xml mapping file -* Posters from TVDB (assign a poster to each AniDB id in AniDB to TVDB mapping file to avoid poster duplicates) -* TVDB episode screenshots -* Episode summary (in English only) courtesy of TVDB through ScudLee's XML episode mappings -* Uses studio from mapping file then AniDB (as often missing from AniDB) -* Search part entirely local through AniDB HTML API database file anime-titles.xml -* Separate language order selection for the series name and episode titles in Agent Settings (Supports Kanji characters in folders, filenames, titles) -* Warnings in html report files (no poster available, episode summary empty, TVDB id not in mapping file) to allow the community to update more easily the mapping XML or TVDB, list of missing episodes -* Collection mapping from ScudLee's movie collection amended with AniDB RelatedAnime field -* Unique posters by using the AniDB id rank in the mapping to rotate the posters -* When a series is not found in AniDB, search TVDB and TMDB automatically -* Trakt scrobbling supports Hama guids +- Both Movies and Series Agent +- AniDB ID to TVDB/TMDB ID matching (with studio and episode mapping list) with ScudLee's xml mapping file +- Posters from TVDB (assign a poster to each AniDB id in AniDB to TVDB mapping file to avoid poster duplicates) +- TVDB episode screenshots +- Episode summary (in English only) courtesy of TVDB through ScudLee's XML episode mappings +- Uses studio from mapping file then AniDB (as often missing from AniDB) +- Search part entirely local through AniDB HTML API database file anime-titles.xml +- Separate language order selection for the series name and episode titles in Agent Settings (Supports Kanji characters in folders, filenames, titles) +- Warnings in html report files (no poster available, episode summary empty, TVDB id not in mapping file) to allow the community to update more easily the mapping XML or TVDB, list of missing episodes +- Collection mapping from ScudLee's movie collection amended with AniDB RelatedAnime field +- Unique posters by using the AniDB id rank in the mapping to rotate the posters +- When a series is not found in AniDB, search TVDB and TMDB automatically +- Trakt scrobbling supports Hama guids ## Project Information -* [:material-home: Absolute Series Scanner (A.S.S.)](https://github.com/ZeroQI/Absolute-Series-Scanner) +- [:material-home: Absolute Series Scanner (A.S.S.)](https://github.com/ZeroQI/Absolute-Series-Scanner) -* [:material-home: HTTP Anidb Metadata Agent (HAMA)](https://github.com/ZeroQI/Hama.bundle) +- [:material-home: HTTP Anidb Metadata Agent (HAMA)](https://github.com/ZeroQI/Hama.bundle) ### 1. Installation @@ -43,4 +43,4 @@ sb install asshama ### 3. Setup -* [:octicons-link-16: Documentation](https://github.com/ZeroQI/Hama.bundle){: .header-icons } +- [:octicons-link-16: Documentation](https://github.com/ZeroQI/Hama.bundle){: .header-icons } diff --git a/docs/apps/autoscan.md b/docs/apps/autoscan.md index e6aed54ca..748768dda 100644 --- a/docs/apps/autoscan.md +++ b/docs/apps/autoscan.md @@ -211,7 +211,7 @@ a_train: Run the a-train tag to create the container: -```bash +```shell sb install sandbox-a-train ``` @@ -219,19 +219,19 @@ Copy one of your service account files from its current location to `/opt/a-trai Example: -```bash +```shell cp /opt/sa/all/160.json /opt/a-train/account.json ``` Run the autoscan tag to rebuild the container: -```bash +```shell sb install autoscan ``` Run the a-train tag to rebuild the container: -```bash +```shell sb install sandbox-a-train ``` diff --git a/docs/apps/cloudplow.md b/docs/apps/cloudplow.md index 8741f7a3b..2e7e03fc1 100644 --- a/docs/apps/cloudplow.md +++ b/docs/apps/cloudplow.md @@ -52,7 +52,7 @@ Note: Config changes require a restart: `sudo systemctl restart saltbox_managed_ Edit in your favorite code editor (with json highlighting) or even a unix editor like nano. -```bash +```shell nano /opt/cloudplow/config.json ``` @@ -188,7 +188,7 @@ If you used the saltbox scripted rclone setup, there is a script that will make Restart Cloudplow to apply the changes to the config. -```bash +```shell sudo systemctl restart saltbox_managed_cloudplow.service ``` @@ -204,6 +204,6 @@ You can run a manual Cloudplow task from anywhere by just using the `cloudplow` To start uploading right away, regardless of what the folder size is: -```bash +```shell cloudplow upload ``` diff --git a/docs/apps/emby.md b/docs/apps/emby.md index 91cfc0edd..7a2b3c59a 100644 --- a/docs/apps/emby.md +++ b/docs/apps/emby.md @@ -35,7 +35,7 @@ tags: - Run the following command: - ```bash + ```shell sb install emby ``` diff --git a/docs/apps/rutorrent.md b/docs/apps/rutorrent.md index 7eab53813..bc4f235a2 100644 --- a/docs/apps/rutorrent.md +++ b/docs/apps/rutorrent.md @@ -69,6 +69,6 @@ You can have custom plugins and themes imported during Docker container rebuild. And then restart the Docker container: -```bash +```shell docker restart rutorrent ``` diff --git a/docs/apps/sabnzbd.md b/docs/apps/sabnzbd.md index 28e50361a..7afe251aa 100644 --- a/docs/apps/sabnzbd.md +++ b/docs/apps/sabnzbd.md @@ -20,7 +20,7 @@ It's totally free, easy to use, and works practically everywhere. SABnzbd makes ## 1. Installation -```bash +```shell sb install sabnzbd ``` diff --git a/docs/faq/hetzner.md b/docs/faq/hetzner.md index 91fd1db49..7b4cef585 100644 --- a/docs/faq/hetzner.md +++ b/docs/faq/hetzner.md @@ -12,7 +12,7 @@ From time to time Hetzner seems to have problems with IPv6 routing to Google so ## Disable IPv6 Temporarily -```bash +```shell sudo sysctl -w net.ipv6.conf.all.disable_ipv6=1 sudo sysctl -w net.ipv6.conf.default.disable_ipv6=1 sudo sysctl -w net.ipv6.conf.lo.disable_ipv6=1 @@ -91,7 +91,7 @@ Setup this [script](https://github.com/Nebarik/mediscripts-shared/blob/main/goog [Markschrik](https://github.com/markschrik) has created a version of the script that will do the required setup for you if you are using the default Saltbox setup; it can be found [here](https://raw.githubusercontent.com/markschrik/Saltbox-GoogleBandwith/main/bandwithtest.sh). Download it, mark it executable, and run it. -```bash +```shell wget https://raw.githubusercontent.com/markschrik/Saltbox-GoogleBandwith/main/bandwithtest.sh chmod +x bandwithtest.sh ./bandwithtest.sh diff --git a/docs/faq/system.md b/docs/faq/system.md index 5d999d1d2..9aa6337bf 100644 --- a/docs/faq/system.md +++ b/docs/faq/system.md @@ -37,7 +37,7 @@ uid=XXXX(yourusername) gid=XXXX(yourgroup) groups=XXXX(yourgroup) - Run the following commands line by line: - ```bash + ```shell sudo useradd -m sudo usermod -aG sudo sudo passwd diff --git a/docs/reference/google-service-accounts.md b/docs/reference/google-service-accounts.md index 9f2307e06..b202a65bd 100644 --- a/docs/reference/google-service-accounts.md +++ b/docs/reference/google-service-accounts.md @@ -120,7 +120,7 @@ uid=1000(marco) gid=1000(marco) groups=1000(marco),... For these edits, you will need: the "Organization ID" from gcloud SDK step, the full email address of the group you created a couple steps ago, and the prefix you generated earlier. - ```bash + ```shell #!/bin/bash # Running this script requires gcloud command line tools. To install go to https://cloud.google.com/sdk/docs/quickstarts # See readme.md to understand the variables used in this script diff --git a/docs/reference/guides/other.md b/docs/reference/guides/other.md index b52999545..57478cc11 100644 --- a/docs/reference/guides/other.md +++ b/docs/reference/guides/other.md @@ -12,7 +12,7 @@ In the rclone install step, copy your `rclone.conf` into place at `/home/seed/.c If your cloud storage remote is not called `google`, you can either rename it, or change the `remote` in settings.yml: -```yml +```yaml rclone: version: latest remote: google ## << HERE diff --git a/docs/reference/guides/tautuliscripts.md b/docs/reference/guides/tautuliscripts.md index a6088eadb..267a366a0 100644 --- a/docs/reference/guides/tautuliscripts.md +++ b/docs/reference/guides/tautuliscripts.md @@ -72,4 +72,4 @@ There is a list of when a notification agent is triggered in the **Notification ### Credit goes to blacktwin -* [https://github.com/blacktwin/JBOPS](https://github.com/blacktwin/JBOPS) +- [https://github.com/blacktwin/JBOPS](https://github.com/blacktwin/JBOPS) diff --git a/docs/reference/plex_auth_token.md b/docs/reference/plex_auth_token.md index f073757f8..a0166ee36 100644 --- a/docs/reference/plex_auth_token.md +++ b/docs/reference/plex_auth_token.md @@ -14,13 +14,13 @@ You will need your Plex credentials filled in `~/saltbox/accounts.yml`. If you a 1. Go to the Saltbox folder: - ```bash + ```shell cd ~/saltbox/ ``` 2. Open the file for editing: - ```bash + ```shell nano accounts.yml ``` From ae9741c85511338c2454d757f1dd3d68234481c4 Mon Sep 17 00:00:00 2001 From: owine Date: Mon, 14 Jul 2025 13:51:02 -0500 Subject: [PATCH 09/16] Add missing H1 headings and fix excessive blank lines --- docs/reference/plex_auth_token.md | 2 ++ docs/reference/preinstall.md | 4 ++-- docs/reference/saltbox-vs-cloudbox.md | 2 +- docs/reference/server.md | 2 +- docs/saltbox/basics/install-types.md | 2 -- docs/sandbox/apps/firefox.md | 2 ++ docs/sandbox/apps/plextraktsync.md | 2 ++ docs/sandbox/apps/profilarr.md | 2 ++ docs/sandbox/apps/teamspeak.md | 2 ++ docs/sandbox/apps/watchstate.md | 2 ++ 10 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/reference/plex_auth_token.md b/docs/reference/plex_auth_token.md index a0166ee36..c2cfec00f 100644 --- a/docs/reference/plex_auth_token.md +++ b/docs/reference/plex_auth_token.md @@ -6,6 +6,8 @@ tags: - token --- +# Plex Auth Token + Here is a way of obtaining a Plex Access Token for your Plex account. ## Saltbox Role diff --git a/docs/reference/preinstall.md b/docs/reference/preinstall.md index 3f05e9603..633875167 100644 --- a/docs/reference/preinstall.md +++ b/docs/reference/preinstall.md @@ -5,12 +5,12 @@ tags: - pre-install --- +# Preinstall + !!! warning This is a reference discussing an aspect of the [install process](../saltbox/install/install.md#step-3-preinstall). If you are looking for the steps to follow to install, they are [here](../saltbox/install/install.md). -## Preinstall - !!! warning Make sure that you have setup the configuration correctly before proceeding. diff --git a/docs/reference/saltbox-vs-cloudbox.md b/docs/reference/saltbox-vs-cloudbox.md index d919daf1f..c7560962c 100644 --- a/docs/reference/saltbox-vs-cloudbox.md +++ b/docs/reference/saltbox-vs-cloudbox.md @@ -5,7 +5,7 @@ tags: - cloudbox --- -## Saltbox vs. Cloudbox +# Saltbox vs Cloudbox Saltbox started out as a branch in Cloudbox while salty was maintaining Cloudbox for about a year and a half so there is a massive carryover from the develop branch of Cloudbox. diff --git a/docs/reference/server.md b/docs/reference/server.md index 2f54a3bed..682533cd3 100644 --- a/docs/reference/server.md +++ b/docs/reference/server.md @@ -6,7 +6,7 @@ tags: - hardware --- -## Server +# Server Requirements ### Getting a Server diff --git a/docs/saltbox/basics/install-types.md b/docs/saltbox/basics/install-types.md index 763d9333b..3d574f770 100644 --- a/docs/saltbox/basics/install-types.md +++ b/docs/saltbox/basics/install-types.md @@ -42,8 +42,6 @@ Saltbox consists of a "Core" with various extra components added onto that core. [yes]:../../images/check-mark.png - - [^1]: Note that the default apps installed by each top-level tag can be overridden with other Saltbox roles [NOT SANDBOX] in the [inventory](../inventory/index.md). If the roles do not exist in Saltbox the install will fail. diff --git a/docs/sandbox/apps/firefox.md b/docs/sandbox/apps/firefox.md index 29de332d1..8d6914462 100644 --- a/docs/sandbox/apps/firefox.md +++ b/docs/sandbox/apps/firefox.md @@ -6,6 +6,8 @@ tags: - browser --- +# Firefox + Implements a Docker container for Firefox. The GUI of the application is accessed through a modern web browser (no installation or configuration needed on the client side) or via any VNC client.
diff --git a/docs/sandbox/apps/plextraktsync.md b/docs/sandbox/apps/plextraktsync.md index 776d5fd63..45913e0cf 100644 --- a/docs/sandbox/apps/plextraktsync.md +++ b/docs/sandbox/apps/plextraktsync.md @@ -6,6 +6,8 @@ tags: - trakt.tv --- +# PlexTraktSync + Self-hosted application that adds a two-way-sync between trakt.tv and Plex Media Server. It requires a trakt.tv account but no Plex premium and no Trakt VIP subscriptions, unlike the Plex app provided by Trakt.
diff --git a/docs/sandbox/apps/profilarr.md b/docs/sandbox/apps/profilarr.md index 25f80eec7..dc1d6ba09 100644 --- a/docs/sandbox/apps/profilarr.md +++ b/docs/sandbox/apps/profilarr.md @@ -8,6 +8,8 @@ tags: - recyclarr --- +# Profilarr + Configuration management and auto-import tool for Radarr/Sonarr custom formats and profiles.
diff --git a/docs/sandbox/apps/teamspeak.md b/docs/sandbox/apps/teamspeak.md index 0379e8673..e310a34f9 100644 --- a/docs/sandbox/apps/teamspeak.md +++ b/docs/sandbox/apps/teamspeak.md @@ -6,6 +6,8 @@ tags: - voicechat --- +# TeamSpeak + Software for quality voice communication via the Internet.
diff --git a/docs/sandbox/apps/watchstate.md b/docs/sandbox/apps/watchstate.md index be5609f90..7dd90f32c 100644 --- a/docs/sandbox/apps/watchstate.md +++ b/docs/sandbox/apps/watchstate.md @@ -8,6 +8,8 @@ tags: - plex --- +# WatchState + This tool's primary goal is to sync your backends' play states without relying on third party services. Out of the box, it supports Jellyfin, Plex and Emby media servers.
From 8ef713995cac317bdc4fbb26c02eec4e8ed7ca52 Mon Sep 17 00:00:00 2001 From: owine Date: Mon, 14 Jul 2025 13:57:09 -0500 Subject: [PATCH 10/16] Improve link accessibility by replacing 'here' links with descriptive text --- docs/advanced/feeder.md | 2 +- docs/advanced/styled-error-pages.md | 2 +- docs/advanced/themepark.md | 2 +- docs/advanced/your-own-containers.md | 2 +- docs/apps/cloudplow.md | 4 ++-- docs/apps/radarr.md | 2 +- docs/apps/sonarr.md | 2 +- docs/faq/hetzner.md | 4 ++-- docs/reference/preinstall.md | 2 +- docs/reference/server.md | 2 +- docs/saltbox/basics/install-types.md | 2 +- docs/saltbox/install/install.md | 30 ++++++++++++++-------------- docs/sandbox/apps/minecraft.md | 4 ++-- docs/sandbox/apps/plex-dupefinder.md | 2 +- docs/sandbox/basics.md | 4 ++-- 15 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/advanced/feeder.md b/docs/advanced/feeder.md index c530c823e..7b57debb0 100644 --- a/docs/advanced/feeder.md +++ b/docs/advanced/feeder.md @@ -20,7 +20,7 @@ _Note: Running the below commands will replace your `unionfs.service` or `merger The following steps will be done on the Mediabox. -1. In `rclone config`, create an `sftp` remote to your Feederbox called `feeder` (Here is an [asciicast](https://asciinema.org/a/184084?t=0&speed=1&size=medium&cols=75&rows=25) video walking through the process). The general process of creating an rclone remote is discussed [here](../reference/guides/rclone-remote.md). +1. In `rclone config`, create an `sftp` remote to your Feederbox called `feeder` (Here is an [asciicast](https://asciinema.org/a/184084?t=0&speed=1&size=medium&cols=75&rows=25) video walking through the process). The general process of creating an rclone remote is discussed in the [rclone remote guide](../reference/guides/rclone-remote.md). _Note: If you don't already have one, add the `feederbox` [subdomain](../reference/subdomain.md) and point it to your Feederbox's IP address. If you are using Cloudflare, make sure CDN/Proxy is not enabled for this subdomain._ diff --git a/docs/advanced/styled-error-pages.md b/docs/advanced/styled-error-pages.md index 35bd4a722..a48093018 100644 --- a/docs/advanced/styled-error-pages.md +++ b/docs/advanced/styled-error-pages.md @@ -32,7 +32,7 @@ There are initially seven "themes" available, which are stored in `/opt/error_pa cats ghost hacker-terminal l7-dark l7-light noise shuffle ``` -Samples of the themed pages can be viewed [here](https://tarampampam.github.io/error-pages/) +Samples of the themed pages can be viewed in the [error pages gallery](https://tarampampam.github.io/error-pages/) ## How do I change the theme? diff --git a/docs/advanced/themepark.md b/docs/advanced/themepark.md index ba73d5b43..c6aaf9dbd 100644 --- a/docs/advanced/themepark.md +++ b/docs/advanced/themepark.md @@ -71,7 +71,7 @@ plex_themepark_enabled: true nzbhydra2_themepark_enabled: true ``` -Available themes can be found [here](https://docs.theme-park.dev/theme-options/). Refer to them in the inventory file by name: +Available themes can be found in the [Theme Park documentation](https://docs.theme-park.dev/theme-options/). Refer to them in the inventory file by name: ```text organizr diff --git a/docs/advanced/your-own-containers.md b/docs/advanced/your-own-containers.md index d53d06b27..aadaba4e3 100644 --- a/docs/advanced/your-own-containers.md +++ b/docs/advanced/your-own-containers.md @@ -12,7 +12,7 @@ When you install existing roles in saltbox, some things get handled behind the s When you add a container manually as outlined on this page, neither of those things will be done for you (unless you have installed our ddns container), so prior to running the docker commands described below you will have to create the `APPNAME.domain.tld` subdomain at cloudflare [or wherever your DNS is] and create the required `/opt/APPNAME` directory tree. -If you want to create a role file that you can install like the built-in applications, see [here](../sandbox/basics.md#contributing-to-sandbox-apps). +If you want to create a role file that you can install like the built-in applications, see [contributing to sandbox apps](../sandbox/basics.md#contributing-to-sandbox-apps). ## Utilizing Generate Traefik Template diff --git a/docs/apps/cloudplow.md b/docs/apps/cloudplow.md index 2e7e03fc1..f81a5d73f 100644 --- a/docs/apps/cloudplow.md +++ b/docs/apps/cloudplow.md @@ -163,7 +163,7 @@ Cloudplow can pause the Sabnzbd download queue when an upload starts; and then r ### Service account uploading -You can tell cloudplow to use a set of service accounts when uploading to Google Drive to go past the daily 750G upload limit. Details are available [here](https://github.com/l3uddz/cloudplow#uploader), but in a nutshell you will add the `service_account_path` to the uploader: +You can tell cloudplow to use a set of service accounts when uploading to Google Drive to go past the daily 750G upload limit. Details are available in the [cloudplow uploader documentation](https://github.com/l3uddz/cloudplow#uploader), but in a nutshell you will add the `service_account_path` to the uploader: ```json "uploader": { @@ -182,7 +182,7 @@ You can tell cloudplow to use a set of service accounts when uploading to Google } ``` -If you used the saltbox scripted rclone setup, there is a script that will make these changes for you described [here](../reference/cloudplow-config.md). +If you used the saltbox scripted rclone setup, there is a script that will make these changes for you described in the [cloudplow configuration guide](../reference/cloudplow-config.md). ### Restart diff --git a/docs/apps/radarr.md b/docs/apps/radarr.md index 777e73fd7..0ae7939d9 100644 --- a/docs/apps/radarr.md +++ b/docs/apps/radarr.md @@ -46,7 +46,7 @@ Make changes in the following sections:
TRaSH' naming guide [Recommended]
- Go [here](https://trash-guides.info/Radarr/Radarr-recommended-naming-scheme/) for the latest updates. These examples may be out of date. + Go to the [TRaSH Guides Radarr naming scheme](https://trash-guides.info/Radarr/Radarr-recommended-naming-scheme/) for the latest updates. These examples may be out of date. Example:
``` diff --git a/docs/apps/sonarr.md b/docs/apps/sonarr.md index 181115228..6adb783c2 100644 --- a/docs/apps/sonarr.md +++ b/docs/apps/sonarr.md @@ -42,7 +42,7 @@ Make changes in the following sections:
TRaSH' naming guide [Recommended]
- Go [here](https://trash-guides.info/Sonarr/Sonarr-recommended-naming-scheme/) for the latest updates. These examples may be out of date. + Go to the [TRaSH Guides Sonarr naming scheme](https://trash-guides.info/Sonarr/Sonarr-recommended-naming-scheme/) for the latest updates. These examples may be out of date. Example:
``` diff --git a/docs/faq/hetzner.md b/docs/faq/hetzner.md index 7b4cef585..1e5e7ae5f 100644 --- a/docs/faq/hetzner.md +++ b/docs/faq/hetzner.md @@ -40,7 +40,7 @@ Alternately you can disable IPv6 using GRUB by editing `/etc/default/grub` and a ipv6.disable=1 ``` -External resource: [here](https://itsfoss.com/disable-ipv6-ubuntu-linux/) +External resource: [It's FOSS IPv6 disable guide](https://itsfoss.com/disable-ipv6-ubuntu-linux/) ## Make Rclone use IPv4 @@ -89,7 +89,7 @@ After doing any changes to Cloudplow or crop configuration remember to restart t Setup this [script](https://github.com/Nebarik/mediscripts-shared/blob/main/googleapis.sh) and let it modify your hosts file. -[Markschrik](https://github.com/markschrik) has created a version of the script that will do the required setup for you if you are using the default Saltbox setup; it can be found [here](https://raw.githubusercontent.com/markschrik/Saltbox-GoogleBandwith/main/bandwithtest.sh). Download it, mark it executable, and run it. +[Markschrik](https://github.com/markschrik) has created a version of the script that will do the required setup for you if you are using the default Saltbox setup; it can be found in the [Saltbox Google Bandwidth script](https://raw.githubusercontent.com/markschrik/Saltbox-GoogleBandwith/main/bandwithtest.sh). Download it, mark it executable, and run it. ```shell wget https://raw.githubusercontent.com/markschrik/Saltbox-GoogleBandwith/main/bandwithtest.sh diff --git a/docs/reference/preinstall.md b/docs/reference/preinstall.md index 633875167..55d76e4bb 100644 --- a/docs/reference/preinstall.md +++ b/docs/reference/preinstall.md @@ -9,7 +9,7 @@ tags: !!! warning This is a reference discussing an aspect of the [install process](../saltbox/install/install.md#step-3-preinstall). - If you are looking for the steps to follow to install, they are [here](../saltbox/install/install.md). + If you are looking for the steps to follow to install, they are in the [installation guide](../saltbox/install/install.md). !!! warning Make sure that you have setup the configuration correctly before proceeding. diff --git a/docs/reference/server.md b/docs/reference/server.md index 682533cd3..e5624b7d2 100644 --- a/docs/reference/server.md +++ b/docs/reference/server.md @@ -42,7 +42,7 @@ Get a server with at least 100GB+ of hard disk space. Even though media is uploa Practically, you should have more like 500GB of space available _at a minimum_. -Cloudplow's default folder size threshold, to upload media to the cloud, is set at 200GB. If you want to lower that, you can find details [here](../apps/cloudplow.md){target=_blank} +Cloudplow's default folder size threshold, to upload media to the cloud, is set at 200GB. If you want to lower that, you can find details in the [Cloudplow configuration documentation](../apps/cloudplow.md){target=_blank} If you are planning to use Usenet, SSD should be considered required, and NVME highly recommended. Usenet is extremely disk I/O intensive. diff --git a/docs/saltbox/basics/install-types.md b/docs/saltbox/basics/install-types.md index 3d574f770..4cff4f91d 100644 --- a/docs/saltbox/basics/install-types.md +++ b/docs/saltbox/basics/install-types.md @@ -73,7 +73,7 @@ As with any Ansible tags provided by saltbox, it is safe to run these install ta ## Feederbox/Mediabox Setup Considerations -- If your servers will share a domain, it is preferred to run only one instance of Authelia. This can run either on the Feederbox or Mediabox as you may choose. The server that will host Authelia should be set as `master: yes` under `authelia:` in `settings.yml` - see [here](../install/install.md#__tabbed_2_2). +- If your servers will share a domain, it is preferred to run only one instance of Authelia. This can run either on the Feederbox or Mediabox as you may choose. The server that will host Authelia should be set as `master: yes` under `authelia:` in `settings.yml` - see [Authelia configuration](../install/install.md#__tabbed_2_2). - On the server hosting Authelia, it is advised to set the `traefik_trusted_ips` variable in your [Inventories](../inventory/index.md) file following the format below. This is for a Mediabox hosting Authelia. If the Feederbox will be hosting, the Mediabox IP would be substituted. diff --git a/docs/saltbox/install/install.md b/docs/saltbox/install/install.md index f9ec7e2cf..481362dfb 100644 --- a/docs/saltbox/install/install.md +++ b/docs/saltbox/install/install.md @@ -78,7 +78,7 @@ However, it is safe to run any saltbox tag[s] [including the install tags] at wi ``` !!! info - See [here](../../reference/dependencies.md) for more information about the dependencies. + See [dependencies documentation](../../reference/dependencies.md) for more information about the dependencies. ## Step 2: Configuration @@ -328,7 +328,7 @@ To edit any of the following configuration files use the command written in the 4. Changes the logging driver used by the Docker daemon from local to json-file. - More information can be found [here](https://docs.docker.com/config/containers/logging/configure/) + More information can be found in the [Docker logging documentation](https://docs.docker.com/config/containers/logging/configure/) 5. Toggles any tasks related to using Intel GPUs. @@ -352,7 +352,7 @@ To edit any of the following configuration files use the command written in the 10. Toggles custom Traefik error pages. - See [here](../../advanced/styled-error-pages.md) for configuration details. + See [styled error pages configuration](../../advanced/styled-error-pages.md) for configuration details. 11. Toggles the use of [HSTS](https://developer.mozilla.org/en-US/docs/Glossary/HSTS). @@ -360,14 +360,14 @@ To edit any of the following configuration files use the command written in the 13. Allows alternate DNS validation providers supported by Traefik. - Implemented ones are listed [here](https://github.com/saltyorg/Saltbox/blob/master/defaults/providers.yml.default). + Implemented ones are listed in [providers.yml.default](https://github.com/saltyorg/Saltbox/blob/master/defaults/providers.yml.default). 14. Defines which subdomain the Traefik dashboard will be accessible at. 15. Defines which subdomain the Traefik Prometheus metrics endpoint will be accessible at. !!! info - See [here](../../reference/accounts.md) for more information about these settings. + See [accounts configuration](../../reference/accounts.md) for more information about these settings. ## Step 3: Preinstall @@ -391,7 +391,7 @@ If your server did not need to reboot, **and the user in `accounts.yml` is diffe If you are installing on a machine where you created a user as part of the ubuntu install, you are currently logged in as that user, and you entered that same user into `accounts.yml`, you **do not** have to run `su username` or reconnect to SSH as that user, and probably should not. You are already logged in as the "saltbox user", and you can just move on to the next step. The `su username` or reconnect are typically required only on remote systems where you may be currently connected as `root`. !!! info - See [here](../../reference/preinstall.md) for more information about the preinstall. + See [preinstall documentation](../../reference/preinstall.md) for more information about the preinstall. ## Step 4: Rclone @@ -439,12 +439,12 @@ Note that generally speaking these five options are mutually exclusive. The simplest possible case is: 1. Set up a Google Project and OAuth Credential file if you don't already have one. - This process is described [here](../../reference/google-project-setup.md). You will need the ID and Secret from that process in step 3 below. That link takes you to one step in a multi-step process. Don't continue to follow that. Follow the steps on that page and then come back here. + This process is described in [Google project setup](../../reference/google-project-setup.md). You will need the ID and Secret from that process in step 3 below. That link takes you to one step in a multi-step process. Don't continue to follow that. Follow the steps on that page and then come back here. 2. Create a Shared Drive in the Google Web UI. [optional] If you don't want to use a shared drive, skip this step, but know that some pieces of saltbox [notably drive monitoring in autoscan] won't work. - This process is described [here](../../reference/guides/google-shared-drive.md). If your Google account doesn't let you create shared drives, it's not the type af account we are assuming, and other things may not work as well. + This process is described in the [Google shared drive guide](../../reference/guides/google-shared-drive.md). If your Google account doesn't let you create shared drives, it's not the type af account we are assuming, and other things may not work as well. 3. Create an rclone remote with those credentials. - This process is described [here](../../reference/guides/rclone-remote.md). + This process is described in the [rclone remote guide](../../reference/guides/rclone-remote.md). 4. enter details about that remote in `settings.yml` Note: that mentions shared drives since that's our recommendation. If you want to point that remote at My Drive you can of course do so. @@ -453,7 +453,7 @@ Note that generally speaking these five options are mutually exclusive. === "Dropbox" - 1. Create rclone remote[s] pointing at Dropbox as described [here](../../reference/guides/rclone-remote-dropbox.md) + 1. Create rclone remote[s] pointing at Dropbox as described in the [Dropbox rclone guide](../../reference/guides/rclone-remote-dropbox.md) 2. enter remote details in `settings.yml` === "Other Cloud Storage" @@ -462,7 +462,7 @@ Note that generally speaking these five options are mutually exclusive. You will need to perform two steps: - 1. Create an rclone remote pointing at your cloud storage as described [here](../../reference/guides/rclone-remote-generic.md) + 1. Create an rclone remote pointing at your cloud storage as described in the [generic rclone guide](../../reference/guides/rclone-remote-generic.md) 2. enter those remote details in `settings.yml` Once you have set up your rclone remote[s], enter their details in `settings.yml` as discussed above in Step 2. @@ -484,7 +484,7 @@ You can get a list of available install tags with `sb list`. === "Saltbox" - `saltbox` is an all-in-one media server for downloading and playback. It installs `core` and a set of application as described [here](../basics/install-types.md) + `saltbox` is an all-in-one media server for downloading and playback. It installs `core` and a set of application as described in [install types](../basics/install-types.md) ```shell sb install saltbox @@ -493,7 +493,7 @@ You can get a list of available install tags with `sb list`. === "Mediabox [playback]" - `mediabox` is just the parts required for playback. It installs `core` and a set of application as described [here](../basics/install-types.md) + `mediabox` is just the parts required for playback. It installs `core` and a set of application as described in [install types](../basics/install-types.md) ```shell sb install mediabox @@ -502,7 +502,7 @@ You can get a list of available install tags with `sb list`. === "Feederbox [downloading]" - `feederbox` is just the parts required for downloading. It installs `core` and a set of application as described [here](../basics/install-types.md) + `feederbox` is just the parts required for downloading. It installs `core` and a set of application as described in [install types](../basics/install-types.md) ```shell sb install feederbox @@ -511,7 +511,7 @@ You can get a list of available install tags with `sb list`. === "Core [minimal]" - `core` is the bare minimum required for saltbox. It installs the basics as described [here](../basics/install-types.md) + `core` is the bare minimum required for saltbox. It installs the basics as described in [install types](../basics/install-types.md) ```shell sb install core diff --git a/docs/sandbox/apps/minecraft.md b/docs/sandbox/apps/minecraft.md index c4827628f..a43d43861 100644 --- a/docs/sandbox/apps/minecraft.md +++ b/docs/sandbox/apps/minecraft.md @@ -33,7 +33,7 @@ This will install [mc-router](../apps/mcrouter.md) and the minecraft server. If ### 3. Multi Server Set Up -To add multiple instances, add the following to the inventory. See these instructions on inventory [here](../../saltbox/inventory/index.md). +To add multiple instances, add the following to the inventory. See the [inventory configuration instructions](../../saltbox/inventory/index.md). ``` yaml @@ -49,7 +49,7 @@ So for the example above, `mcserver1._yourdomain.com_` and `mcserver2._yourdomai ### 4. Setup -For individual servers, you can change things such as memory using custom docker envs. See instructions on inventory [here](../../saltbox/inventory/index.md) +For individual servers, you can change things such as memory using custom docker envs. See the [inventory configuration instructions](../../saltbox/inventory/index.md) For a single install, the inventory vars will look like this `minecraft_docker_image_tag`. diff --git a/docs/sandbox/apps/plex-dupefinder.md b/docs/sandbox/apps/plex-dupefinder.md index 8dbaaacee..11101007c 100644 --- a/docs/sandbox/apps/plex-dupefinder.md +++ b/docs/sandbox/apps/plex-dupefinder.md @@ -16,7 +16,7 @@ tags: - Duplicates can be either in bulk (automatic) or one-by-one (interactively). !!! note - 📢 You will need to have `allow media deletion: enabled` ticked. [here](https://github.com/l3uddz/plex_dupefinder#plex) + 📢 You will need to have `allow media deletion: enabled` ticked. See the [Plex configuration instructions](https://github.com/l3uddz/plex_dupefinder#plex) | Details | | | |-------------|-------------|-------------| diff --git a/docs/sandbox/basics.md b/docs/sandbox/basics.md index 709a939a0..81dcd2d1b 100644 --- a/docs/sandbox/basics.md +++ b/docs/sandbox/basics.md @@ -70,7 +70,7 @@ sb list ### Requesting Sandbox Apps -If you have an idea for a container that you think fits into the Saltbox system but you don't feel you have the required skills to create a role, open an issue in the sandbox repo [here](https://github.com/saltyorg/Sandbox/issues). Take a look at some other app requests and follow the same pattern. If your suggestion catches a developer's interest, perhaps they will pick it up. +If you have an idea for a container that you think fits into the Saltbox system but you don't feel you have the required skills to create a role, open an issue in the [Sandbox repository](https://github.com/saltyorg/Sandbox/issues). Take a look at some other app requests and follow the same pattern. If your suggestion catches a developer's interest, perhaps they will pick it up. !!! note Requests are just that, *requests*. Nobody is being paid for their work on this. Requests may not be implemented in a timely manner or at all. @@ -163,7 +163,7 @@ roles/my-cool-role/tasks/main.yml This file drives the install of your role. The stuff in there should be self-explanatory or understandable with comparisons to existing roles; if it's not, then again, with all respect you probably shouldn't be creating a role right now. -There is a wiki article on adding new containers [here](../advanced/your-own-containers.md); this may be of some use. +There is a [wiki article on adding new containers](../advanced/your-own-containers.md); this may be of some use. Don't forget the header in both these files: From 17eb0497a742327c1dcb6b630c0d0d6bacae19c6 Mon Sep 17 00:00:00 2001 From: owine Date: Mon, 14 Jul 2025 13:59:38 -0500 Subject: [PATCH 11/16] Add alt text to images in reference and app documentation for accessibility --- docs/apps/emby.md | 2 +- docs/apps/plex.md | 4 ++-- docs/reference/domain.md | 22 +++++++++---------- docs/reference/google-account-perms.md | 12 +++++----- docs/reference/google-gcloud-tools-install.md | 2 +- docs/reference/server.md | 8 +++---- 6 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/apps/emby.md b/docs/apps/emby.md index 7a2b3c59a..d770a0a4e 100644 --- a/docs/apps/emby.md +++ b/docs/apps/emby.md @@ -17,7 +17,7 @@ tags: ## 1. Introduction -![](../images/emby/emby-splash.jpg) +![Emby media server splash screen and logo](../images/emby/emby-splash.jpg) ## 2. URL diff --git a/docs/apps/plex.md b/docs/apps/plex.md index 760fdf5d7..cc323c8fc 100644 --- a/docs/apps/plex.md +++ b/docs/apps/plex.md @@ -91,7 +91,7 @@ tags: 1. Click "SAVE CHANGES". - ![](../images/plex-media-server/plex-08-network.jpeg) + ![Plex Network settings page showing custom server access URLs configuration](../images/plex-media-server/plex-08-network.jpeg) === "Transcoder" @@ -141,7 +141,7 @@ tags: 3. Click "SAVE CHANGES". - ![](../images/plex-media-server/plex-11-schedule.jpeg) + ![Plex Scheduled Tasks settings showing extensive media analysis disabled](../images/plex-media-server/plex-11-schedule.jpeg) === "Remote Access" diff --git a/docs/reference/domain.md b/docs/reference/domain.md index 20070c860..73df771bd 100644 --- a/docs/reference/domain.md +++ b/docs/reference/domain.md @@ -47,7 +47,7 @@ Pick one of the setups below. Your choice will depend on whether you meet certai Namecheap > Domain List > Manage > Advanced DNS > Add New Record > A Record > `*` for Host > Server IP for Value. - ![](../images/cloudflare/cloudflare-a-record.png) + ![Cloudflare DNS settings showing A record configuration with wildcard host and server IP](../images/cloudflare/cloudflare-a-record.png)
@@ -158,13 +158,13 @@ Pick one of the setups below. Your choice will depend on whether you meet certai "Dashboard" -> _your domain.tld_ -> "Manage" -> "Name Servers" -> "Custom DNS" -> add the nameservers in. - ![](../images/namecheap-dns.png) + ![Namecheap domain management showing Custom DNS nameserver configuration](../images/namecheap-dns.png) === "Namesilo.com" "Manage My Domains" -> _your domain.tld_ -> "NameServers" -> "Change" -> add the nameservers in. - ![](../images/namesilo-dns.png) + ![Namesilo domain management interface showing nameserver change options](../images/namesilo-dns.png) #### Setup @@ -172,13 +172,13 @@ Pick one of the setups below. Your choice will depend on whether you meet certai 2. Here you will see that your domain will have an "Active" status. Click on your domain to continue. - ![](../images/cloudflare/cloudflare-active.png) + ![Cloudflare dashboard showing domain with Active status](../images/cloudflare/cloudflare-active.png) 3. Click the **SSL/TLS** tab. 4. Set **SSL** to `Full (strict)`. - ![](../images/cloudflare/cloudflare-full-strict.png) + ![Cloudflare SSL/TLS settings page with Full (strict) encryption mode selected](../images/cloudflare/cloudflare-full-strict.png) #### Get a [free] Cloudflare API Key @@ -188,19 +188,19 @@ Pick one of the setups below. Your choice will depend on whether you meet certai 3. Click **Get your API token**. - ![](../images/cloudflare/cloudflare-api-token.png){ width=60% } + ![Cloudflare Overview tab showing 'Get your API token' button](../images/cloudflare/cloudflare-api-token.png){ width=60% } 4. Under **API Keys** and then **Global API Key** click **View**. - ![](../images/cloudflare/cloudflare-global-api.png){ width=60% } + ![Cloudflare API Keys section highlighting Global API Key View button](../images/cloudflare/cloudflare-global-api.png){ width=60% } 5. On the login popup, type in your **password** and click **View**. - ![](../images/cloudflare/cloudflare-api-password.png){ width=50% } + ![Cloudflare password confirmation dialog for viewing API key](../images/cloudflare/cloudflare-api-password.png){ width=50% } 6. Save your API key. - ![](../images/cloudflare/cloudflare-api-show.png){ width=50% } + ![Cloudflare interface displaying the Global API Key for copying](../images/cloudflare/cloudflare-api-show.png){ width=50% } #### Add the Cloudflare API Key to the saltbox settings: @@ -228,7 +228,7 @@ Pick one of the setups below. Your choice will depend on whether you meet certai 4. Under "Status", click the switch next to the gray cloud icon (i.e. `DNS Only`) to switch to an orange one (i.e. `DNS and HTTP proxy (CDN)`). - ![](../images/cloudflare/cloudflare-proxy-off.png){ width=60% } + ![Cloudflare DNS tab showing subdomain with proxy status toggle (DNS Only mode)](../images/cloudflare/cloudflare-proxy-off.png){ width=60% } diff --git a/docs/reference/google-account-perms.md b/docs/reference/google-account-perms.md index 170aa8571..ef4559f3e 100644 --- a/docs/reference/google-account-perms.md +++ b/docs/reference/google-account-perms.md @@ -16,27 +16,27 @@ NOTE: This guide is assuming a Google Gsuite Business/Workspace account. 1. Go to ; from the left-hand menu select "Apps > Google Workspace > Drive and Docs": - ![](../images/google-shared-drive-settings/01-DND-menu.png) + ![Google Admin Console showing Apps > Google Workspace > Drive and Docs menu selection](../images/google-shared-drive-settings/01-DND-menu.png) 2. Verify that Drive is turned on for your organization: - ![](../images/google-shared-drive-settings/02-DND-main.png) + ![Drive and Docs settings page showing Drive is turned on for the organization](../images/google-shared-drive-settings/02-DND-main.png) 3. If it is not, click on the triangle on the right of that section and enable it if needed. After clicking "SAVE" [if you changed the setting] click back to "Settings for Drive and Docs": - ![](../images/google-shared-drive-settings/03-DND-status.png) + ![Drive status configuration page with settings enabled](../images/google-shared-drive-settings/03-DND-status.png) 4. Back on the that screen, click on the "Sharing settings" section: - ![](../images/google-shared-drive-settings/04-DND-sharing.png) + ![Drive and Docs settings highlighting the Sharing settings section](../images/google-shared-drive-settings/04-DND-sharing.png) 5. Scroll down and verify that your "Shared Drive Settings" match these. Change them if required and save: - ![](../images/google-shared-drive-settings/05-DND-sharing-settings.png) + ![Shared Drive Settings configuration page with recommended settings](../images/google-shared-drive-settings/05-DND-sharing-settings.png) 6. Scroll down to "Shared drive creation" and verify that your settings match these: - ![](../images/google-shared-drive-settings/06-DND-creation-settings.png) + ![Shared drive creation settings with recommended configuration options](../images/google-shared-drive-settings/06-DND-creation-settings.png) 7. You're done. diff --git a/docs/reference/google-gcloud-tools-install.md b/docs/reference/google-gcloud-tools-install.md index bfccd0bae..0b2221c37 100644 --- a/docs/reference/google-gcloud-tools-install.md +++ b/docs/reference/google-gcloud-tools-install.md @@ -58,7 +58,7 @@ It's assuming you're working through the steps from [here](rclone-manual.md) and 2. Log into your Google account and approve the access request: - ![](../images/gcloud-sdk/02-sdk-approve.png) + ![Google OAuth consent screen showing gcloud CLI access request approval dialog](../images/gcloud-sdk/02-sdk-approve.png) Copy the verification code. diff --git a/docs/reference/server.md b/docs/reference/server.md index e5624b7d2..e6a5a5364 100644 --- a/docs/reference/server.md +++ b/docs/reference/server.md @@ -66,7 +66,7 @@ If you are setting this up on a home server, verify, **before installing Saltbox - If you get an option like below, select choose Ubuntu 22 or better, which may be named something like `ubuntu-2204-jammy-64-minimal` or `ubuntu-2404-noble-64-minimal`. - ![](../images/ubuntu-selection.png) + ![Server installation interface showing Ubuntu version selection options](../images/ubuntu-selection.png) Note that the image is well out of date, but the concept is the important thing. @@ -89,12 +89,12 @@ Examples: **IMPORTANT**: Note that these examples are just that, _examples_, and may not reflect currently-available OS versions or the current state of the UI. They were accurate at the time of capture, but things change that are outside saltbox' control. You will need to review for accuracy and possibly adapt them to your specific situation. You're partitioning the disk of your remote server; you generally shouldn't trust that to copy-pasting some text from a web page. === "Online.net" - ![](../images/online-net-partitioning.png) + ![Online.net server partitioning configuration interface](../images/online-net-partitioning.png) === "OVH" - ![](../images/ovh-partitioning.png) + ![OVH server partitioning setup interface showing disk configuration](../images/ovh-partitioning.png) - ![](../images/ovh-partitioning2.png) + ![OVH server partitioning continuation page with additional disk options](../images/ovh-partitioning2.png) === "Hetzner" From 88836faa2111a6d470bfca787f9f5ca3bca4ca23 Mon Sep 17 00:00:00 2001 From: owine Date: Mon, 14 Jul 2025 14:01:02 -0500 Subject: [PATCH 12/16] Add alt text to themepark documentation images for accessibility --- docs/advanced/themepark.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/advanced/themepark.md b/docs/advanced/themepark.md index c6aaf9dbd..d8bc69d54 100644 --- a/docs/advanced/themepark.md +++ b/docs/advanced/themepark.md @@ -15,15 +15,15 @@ For example: NZBGet default appearance: -![](images/nzbget-before.png) +![NZBGet interface showing default appearance before theme application](images/nzbget-before.png) NZBGet with the "nord" theme: -![](images/nzbget-nord.png) +![NZBGet interface with nord theme applied showing dark color scheme](images/nzbget-nord.png) Sonarr with the "hotline" theme: -![](images/sonarr-hotline.png) +![Sonarr interface with hotline theme showing bright pink and dark styling](images/sonarr-hotline.png) Choose the theme and apply it to containers in in inventory: From 05926aec8445bb8edce96ac5fbea6a7820b31f83 Mon Sep 17 00:00:00 2001 From: owine Date: Mon, 14 Jul 2025 14:04:51 -0500 Subject: [PATCH 13/16] Fix broken internal links to system.md after file rename --- docs/faq/plex.md | 2 +- docs/faq/rclone.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/faq/plex.md b/docs/faq/plex.md index 958c31a25..feeb6bc17 100644 --- a/docs/faq/plex.md +++ b/docs/faq/plex.md @@ -91,7 +91,7 @@ Reorder the Plex agents for trhe library so that local assets are at the bottom. ## Fix permission issues with Plex logs -Replace `user` and `group` to match yours' (see [here](System.md#find-your-user-id-uid-and-group-id-gid)). +Replace `user` and `group` to match yours' (see [here](system.md#find-your-user-id-uid-and-group-id-gid)). ```shell sudo chown -R user:group /opt/plex/Library/Logs diff --git a/docs/faq/rclone.md b/docs/faq/rclone.md index d440a3bac..89879b932 100644 --- a/docs/faq/rclone.md +++ b/docs/faq/rclone.md @@ -10,7 +10,7 @@ tags: ## Rclone error: Failed to save config file: open /home/\/.config/rclone/rclone.conf: permission denied -Replace `user` and `group` to match yours (see [here](System.md#find-your-user-id-uid-and-group-id-gid)). +Replace `user` and `group` to match yours (see [here](system.md#find-your-user-id-uid-and-group-id-gid)). ```shell sudo chown -R user:group ~/.config/rclone/ From 5bea79a204158f1f6248afd06f866ce74a13843b Mon Sep 17 00:00:00 2001 From: owine Date: Fri, 15 Aug 2025 10:19:22 -0500 Subject: [PATCH 14/16] Add docker compose and docker run related tags to your-own-containers page --- docs/advanced/your-own-containers.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/advanced/your-own-containers.md b/docs/advanced/your-own-containers.md index aadaba4e3..3ad1e9d88 100644 --- a/docs/advanced/your-own-containers.md +++ b/docs/advanced/your-own-containers.md @@ -4,6 +4,10 @@ hide: tags: - container - add + - docker-compose + - docker-run + - docker + - compose --- # Adding your own containers to Saltbox From 85291a7bc76e969471e350cee3831f2e5abd1e70 Mon Sep 17 00:00:00 2001 From: owine Date: Fri, 15 Aug 2025 10:32:02 -0500 Subject: [PATCH 15/16] Fix capitalization consistency and improve grammar across documentation - Standardize Saltbox, Cloudflare, Google Drive capitalization - Fix grammar issues in your-own-containers page - Improve writing clarity and punctuation - Correct possessive forms and compound sentences --- docs/advanced/your-own-containers.md | 112 +++++++++++++++++---------- docs/faq/plex.md | 2 +- docs/faq/system.md | 2 +- unused-pages/rclone-auto.md | 4 +- unused-pages/switch_to_local.md | 12 +-- 5 files changed, 81 insertions(+), 51 deletions(-) diff --git a/docs/advanced/your-own-containers.md b/docs/advanced/your-own-containers.md index 3ad1e9d88..cea3c6e4c 100644 --- a/docs/advanced/your-own-containers.md +++ b/docs/advanced/your-own-containers.md @@ -12,33 +12,59 @@ tags: # Adding your own containers to Saltbox -When you install existing roles in saltbox, some things get handled behind the scenes for you. Notably, this includes creating the subdomain[s] at cloudflare and creating the `/opt/APPNAME` directory tree. +When you install existing roles in Saltbox, some things get handled behind the scenes for you. Notably, this includes creating the subdomain[s] at Cloudflare and creating the `/opt/APPNAME` directory tree. -When you add a container manually as outlined on this page, neither of those things will be done for you (unless you have installed our ddns container), so prior to running the docker commands described below you will have to create the `APPNAME.domain.tld` subdomain at cloudflare [or wherever your DNS is] and create the required `/opt/APPNAME` directory tree. +When you add a container manually as outlined on this page, neither of those things will be done for you (unless you have installed our ddns container), so prior to running the docker commands described below you will have to create the `APPNAME.domain.tld` subdomain at Cloudflare [or wherever your DNS is] and create the required `/opt/APPNAME` directory tree. + +!!! info "Two approaches available" + - **Recommended:** Use the [Generate Traefik Template](#utilizing-generate-traefik-template-recommended) for the easiest setup + - **Advanced:** Manually create docker-compose files using the [templates below](#docker-compose) If you want to create a role file that you can install like the built-in applications, see [contributing to sandbox apps](../sandbox/basics.md#contributing-to-sandbox-apps). -## Utilizing Generate Traefik Template +## Utilizing Generate Traefik Template (Recommended) + +!!! tip "Easiest Method" + Using the Generate Traefik Template is the **easiest and preferred way** to get started with adding your own containers to Saltbox. This tool will automatically generate a properly configured docker-compose file for you. -Create your application folder +1. Create your application folder: + ```shell mkdir /opt/APPNAME + ``` -Run the Generate Traefik Template +2. Run the Generate Traefik Template: + ```shell sb install generate-traefik-template + ``` + +3. Answer the prompts for your container configuration. Saltbox will create a file at `/tmp/docker-compose.yml` + +4. Move the generated file to your application directory: -Once you've answered the required fields, Saltbox will create a file in `/tmp/docker-compose.yml` + ```shell + mv /tmp/docker-compose.yml /opt/APPNAME/ + ``` + +5. Edit `/opt/APPNAME/docker-compose.yml` to customize it for your specific container requirements. + +6. Start your container: -Move the newly created `/tmp/docker-compose.yml` to the `/opt/APPNAME` + ```shell + cd /opt/APPNAME + docker compose up -d + ``` - mv /tmp/docker-compose.yml /opt/APPNAME +!!! note + The generated template includes all the necessary Traefik labels and Saltbox-specific configurations. You'll only need to modify the image name, ports, volumes, and environment variables specific to your application. -Once moved, modify `/opt/APPNAME/docker-compose.yml` to the requirements of your container. See IMPORTANT below. +## Docker Compose (Manual Setup) -IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and `DOCKER/IMAGE:TAG` are _placeholders_. *You need to change those* **everywhere they appear** to match the application you are installing. +!!! warning "Advanced Users Only" + The templates below are for users who prefer to manually create their docker-compose files. For most users, the [Generate Traefik Template](#utilizing-generate-traefik-template-recommended) method above is much easier and less error-prone. -## Docker Compose +IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and `DOCKER/IMAGE:TAG` are _placeholders_. _You need to change those_ **everywhere they appear** to match the application you are installing. === "Using Traefik (Authelia)" ```yaml @@ -77,7 +103,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and external: true ``` - 1. Defines the containers restart policy. + 1. Defines the container's restart policy. [Reference](https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy) @@ -86,7 +112,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and 4. Defines the hostname used on the Docker network. 5. Defines the environment variables which are often used to change configuration of the underlying application inside of the container. - While the TZ (Timezone) variable is used in pretty much all containers you will have to figure out the rest as it can differ quite a bit between different containers. + While the TZ (Timezone) variable is used in pretty much all containers, you will have to figure out the rest as it can differ quite a bit between different containers. 6. Defines which Docker networks the container will join upon creation. @@ -102,7 +128,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and A list of currently added middleware can be found on the Traefik dashboard (dash.domain.tld). - Unless you intend to allow HTTP traffic instead of auto-upgrading to HTTPS make sure to include the redirect-to-https middleware. + Unless you intend to allow HTTP traffic instead of auto-upgrading to HTTPS, make sure to include the redirect-to-https middleware. 11. This value defines which locations Traefik routes to the application. @@ -126,17 +152,17 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and If the url is using Cloudflare, with the same account as Saltbox uses, the value should be `cfdns`. - If you don't use Cloudflare with the URL used or another reason why it cannot use DNS validation use `httpresolver`. + If you don't use Cloudflare with the URL used, or for another reason it cannot use DNS validation, use `httpresolver`. Remember to enable http_validation in the adv_settings.yml config to enable the httpresolver when using Cloudflare. - 18. Defines the configuration used for SSL, leave this alone unless you know what you are doing. + 18. Defines the configuration used for SSL; leave this alone unless you know what you are doing. 19. Defines which port Traefik routes the traffic to. 20. Add any volume mounts the container needs. /host_path:/container_path - 21. This section tells docker compose that the network is managed outside of this compose file. + 21. This section tells Docker Compose that the network is managed outside of this compose file. === "Using Traefik (Authelia + API Router)" ```yaml @@ -187,7 +213,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and external: true ``` - 1. Defines the containers restart policy. + 1. Defines the container's restart policy. [Reference](https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy) @@ -196,7 +222,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and 4. Defines the hostname used on the Docker network. 5. Defines the environment variables which are often used to change configuration of the underlying application inside of the container. - While the TZ (Timezone) variable is used in pretty much all containers you will have to figure out the rest as it can differ quite a bit between different containers. + While the TZ (Timezone) variable is used in pretty much all containers, you will have to figure out the rest as it can differ quite a bit between different containers. 6. Defines which Docker networks the container will join upon creation. @@ -212,15 +238,15 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and A list of currently added middleware can be found on the Traefik dashboard (dash.domain.tld). - Unless you intend to allow HTTP traffic instead of auto-upgrading to HTTPS make sure to include the redirect-to-https middleware. + Unless you intend to allow HTTP traffic instead of auto-upgrading to HTTPS, make sure to include the redirect-to-https middleware. 11. Defines router priority. - If multiple router paths match a given address the one with the highest priority is used. + If multiple router paths match a given address, the one with the highest priority is used. 12. This value defines which locations Traefik routes to the application. - With the API Router we only add paths to the router that should go around Authelia. + With the API Router, we only add paths to the router that should bypass Authelia. Docs: https://doc.traefik.io/traefik/routing/routers/#rule @@ -235,11 +261,11 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and 16. Defines router priority. - If multiple router paths match a given address the one with the highest priority is used. + If multiple router paths match a given address, the one with the highest priority is used. 17. This value defines which locations Traefik routes to the application. - With the API Router we only add paths to the router that should go around Authelia. + With the API Router, we only add paths to the router that should bypass Authelia. Docs: https://doc.traefik.io/traefik/routing/routers/#rule @@ -248,7 +274,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and If the url is using Cloudflare, with the same account as Saltbox uses, the value should be `cfdns`. - If you don't use Cloudflare with the URL used or another reason why it cannot use DNS validation use `httpresolver`. + If you don't use Cloudflare with the URL used, or for another reason it cannot use DNS validation, use `httpresolver`. Remember to enable http_validation in the adv_settings.yml config to enable the httpresolver when using Cloudflare. @@ -261,7 +287,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and A list of currently added middleware can be found on the Traefik dashboard (dash.domain.tld). - Unless you intend to allow HTTP traffic instead of auto-upgrading to HTTPS make sure to include the redirect-to-https middleware. + Unless you intend to allow HTTP traffic instead of auto-upgrading to HTTPS, make sure to include the redirect-to-https middleware. 23. This value defines which locations Traefik routes to the application. @@ -285,7 +311,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and If the url is using Cloudflare, with the same account as Saltbox uses, the value should be `cfdns`. - If you don't use Cloudflare with the URL used or another reason why it cannot use DNS validation use `httpresolver`. + If you don't use Cloudflare with the URL used, or for another reason it cannot use DNS validation, use `httpresolver`. Remember to enable http_validation in the adv_settings.yml config to enable the httpresolver when using Cloudflare. @@ -295,7 +321,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and /host_path:/container_path - 33. This section tells docker compose that the network is managed outside of this compose file. + 33. This section tells Docker Compose that the network is managed outside of this compose file. === "Using Traefik" ```yaml @@ -334,7 +360,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and external: true ``` - 1. Defines the containers restart policy. + 1. Defines the container's restart policy. [Reference](https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy) @@ -343,7 +369,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and 4. Defines the hostname used on the Docker network. 5. Defines the environment variables which are often used to change configuration of the underlying application inside of the container. - While the TZ (Timezone) variable is used in pretty much all containers you will have to figure out the rest as it can differ quite a bit between different containers. + While the TZ (Timezone) variable is used in pretty much all containers, you will have to figure out the rest as it can differ quite a bit between different containers. 6. Defines which Docker networks the container will join upon creation. @@ -359,7 +385,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and A list of currently added middleware can be found on the Traefik dashboard (dash.domain.tld). - Unless you intend to allow HTTP traffic instead of auto-upgrading to HTTPS make sure to include the redirect-to-https middleware. + Unless you intend to allow HTTP traffic instead of auto-upgrading to HTTPS, make sure to include the redirect-to-https middleware. 11. This value defines which locations Traefik routes to the application. @@ -383,17 +409,17 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and If the url is using Cloudflare, with the same account as Saltbox uses, the value should be `cfdns`. - If you don't use Cloudflare with the URL used or another reason why it cannot use DNS validation use `httpresolver`. + If you don't use Cloudflare with the URL used, or for another reason it cannot use DNS validation, use `httpresolver`. Remember to enable http_validation in the adv_settings.yml config to enable the httpresolver when using Cloudflare. - 18. Defines the configuration used for SSL, leave this alone unless you know what you are doing. + 18. Defines the configuration used for SSL; leave this alone unless you know what you are doing. 19. Defines which port Traefik routes the traffic to. 20. Add any volume mounts the container needs. /host_path:/container_path - 21. This section tells docker compose that the network is managed outside of this compose file. + 21. This section tells Docker Compose that the network is managed outside of this compose file. === "Without Traefik" ```yaml @@ -420,7 +446,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and external: true ``` - 1. Defines the containers restart policy. + 1. Defines the container's restart policy. [Reference](https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy) @@ -429,7 +455,7 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and 4. Defines the hostname used on the Docker network. 5. Defines the environment variables which are often used to change configuration of the underlying application inside of the container. - While the TZ (Timezone) variable is used in pretty much all containers you will have to figure out the rest as it can differ quite a bit between different containers. + While the TZ (Timezone) variable is used in pretty much all containers, you will have to figure out the rest as it can differ quite a bit between different containers. 6. Defines which Docker networks the container will join upon creation. @@ -440,18 +466,22 @@ IMPORTANT: In the examples below, `APPNAME`, `APPLICATION_PORT`, `/CONFIG`, and /host_path:/container_path - 9. This section tells docker compose that the network is managed outside of this compose file. + 9. This section tells Docker Compose that the network is managed outside of this compose file. ## Creating and running the container -Once you have a docker-compose file as described above, you will use standard docker commands to create and run the container. +Once you have a docker-compose file as described above, you will use standard Docker commands to create and run the container. If the file is named `docker-compose.yml` and is located in the current working directory: - docker compose up -d +```shell +docker compose up -d +``` If the file has some other name or is located elsewhere in the file system: - docker compose -f /path/to/something.yml up -d +```shell +docker compose -f /path/to/something.yml up -d +``` -Remember to create the `APPNAME.domain.tld` subdomain at cloudflare [or wherever your DNS is] and create the required `/opt/APPNAME` directory tree prior to running that command. +Remember to create the `APPNAME.domain.tld` subdomain at Cloudflare [or wherever your DNS is] and create the required `/opt/APPNAME` directory tree prior to running that command. diff --git a/docs/faq/plex.md b/docs/faq/plex.md index feeb6bc17..5452da890 100644 --- a/docs/faq/plex.md +++ b/docs/faq/plex.md @@ -61,7 +61,7 @@ SOME COMMANDS ON THIS PAGE IRREVOCABLY DELETE DATA === "Use SSH to tunnel to my server and claim it" - - On your local machine (the one that you uise to ssh into your saltbox machine): + - On your local machine (the one that you use to ssh into your Saltbox machine): ```shell ssh @ -L 32400:0.0.0.0:32400 -N diff --git a/docs/faq/system.md b/docs/faq/system.md index 9aa6337bf..d8da67786 100644 --- a/docs/faq/system.md +++ b/docs/faq/system.md @@ -49,7 +49,7 @@ uid=XXXX(yourusername) gid=XXXX(yourgroup) groups=XXXX(yourgroup) The generally correct way to do this is to change the setting and run `sb install shell` -If you want to do this outside the saltbox context, carry on. +If you want to do this outside the Saltbox context, carry on. How to check current shell: diff --git a/unused-pages/rclone-auto.md b/unused-pages/rclone-auto.md index 32e129f2e..ea3e69aec 100644 --- a/unused-pages/rclone-auto.md +++ b/unused-pages/rclone-auto.md @@ -8,8 +8,8 @@ tags: ## Automated rclone setup -There were initially plans for saltbox to have an automated rclone setup for google drive. +There were initially plans for Saltbox to have an automated rclone setup for Google Drive. Changes to Google's "unlimited" offering have back-burnered this effort indefinitely. -If you want to set up saltbox using Google Drive, please follow the [partially scripted version of this process](rclone-manual.md). +If you want to set up Saltbox using Google Drive, please follow the [partially scripted version of this process](rclone-manual.md). diff --git a/unused-pages/switch_to_local.md b/unused-pages/switch_to_local.md index ff76a7dc2..84e14b76f 100644 --- a/unused-pages/switch_to_local.md +++ b/unused-pages/switch_to_local.md @@ -6,13 +6,13 @@ Conceptually, this is simple. 1. Set up your local storage - Maybe this is a NAS, or a bunch of disks in the saltbox machine, or something else. Step one is going to be setting this up. + Maybe this is a NAS, or a bunch of disks in the Saltbox machine, or something else. Step one is going to be setting this up. 2. Copy your media from the cloud to that local storage This is probably going to be an rclone copy and will mostly be waiting. -3. Point your saltbox server at that local storage. +3. Point your Saltbox server at that local storage. This would include things like: @@ -33,7 +33,7 @@ One thing's for sure; you're buying a lot of disks. ### Copy your media from the cloud to that local storage -First, halt all downloading on your saltbox machine; you don't need anything getting changed or added while you go through this exercise. +First, halt all downloading on your Saltbox machine; you don't need anything getting changed or added while you go through this exercise. Depoending on you personal situation, you may or may not want to copy everything down from your cloud storage. If you do, though, this is going to be some variation on: @@ -43,17 +43,17 @@ rclone copy CLOUD_STORAGE_REMOTE:/PATH LOCATION_OF_LOCAL_STORAGE:/PATH Probably with some rclone flags to improve performance for your specific cloud storage provider. -For example, if you have a standard saltbox setup, and you have mounted your local storage at `/mnt/nas`, maybe something like: +For example, if you have a standard Saltbox setup, and you have mounted your local storage at `/mnt/nas`, maybe something like: ``` rclone copy google:/Media /mnt/nas/Media --drive-chunk-size 128M --transfers 8 --checkers 8 --tpslimit 8 --fast-list --checksum --progress ``` -### Point your saltbox server at that local storage. +### Point your Saltbox server at that local storage. Since in this case you just copied everything down, `/mnt/nas/Media` is now a mirror of `/mnt/remote/Media` -The simplest thing here is to use the same rclone + cloudbox setup as saltbox does normally. +The simplest thing here is to use the same rclone + cloudbox setup as Saltbox does normally. Stop all your docker containers. From 11270dbc43e78b268e8d53a23b91460562516a51 Mon Sep 17 00:00:00 2001 From: owine Date: Fri, 15 Aug 2025 10:34:36 -0500 Subject: [PATCH 16/16] Fix broken anchor link in your-own-containers page - Update link fragment to match actual heading ID - Fixes warning about missing anchor #docker-compose --- docs/advanced/your-own-containers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/advanced/your-own-containers.md b/docs/advanced/your-own-containers.md index cea3c6e4c..5e8eb2d66 100644 --- a/docs/advanced/your-own-containers.md +++ b/docs/advanced/your-own-containers.md @@ -18,7 +18,7 @@ When you add a container manually as outlined on this page, neither of those thi !!! info "Two approaches available" - **Recommended:** Use the [Generate Traefik Template](#utilizing-generate-traefik-template-recommended) for the easiest setup - - **Advanced:** Manually create docker-compose files using the [templates below](#docker-compose) + - **Advanced:** Manually create docker-compose files using the [templates below](#docker-compose-manual-setup) If you want to create a role file that you can install like the built-in applications, see [contributing to sandbox apps](../sandbox/basics.md#contributing-to-sandbox-apps).