diff --git a/docs/advanced/feeder.md b/docs/advanced/feeder.md index 041d5ea03..c530c823e 100644 --- a/docs/advanced/feeder.md +++ b/docs/advanced/feeder.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - feeder + - feedermount +--- + +# Feeder Mount + # Intro For setups with separate Feeder and Media boxes, you will have newly downloaded media that will not be instantly available on cloud storage (e.g. Google Drive) and, therefore, inaccessible to Mediabox (e.g. Plex) when Sonarr/Radarr sends a media scan request. diff --git a/docs/advanced/healthchecks.md b/docs/advanced/healthchecks.md index b14494618..ddd21893c 100644 --- a/docs/advanced/healthchecks.md +++ b/docs/advanced/healthchecks.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - healthcheck +--- + # Container Healthchecks Saltbox can set a custom healthcheck on a Docker container via the [inventory system](../saltbox/inventory/index.md). diff --git a/docs/advanced/styled-error-pages.md b/docs/advanced/styled-error-pages.md index c0236c773..359856b2c 100644 --- a/docs/advanced/styled-error-pages.md +++ b/docs/advanced/styled-error-pages.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - error +--- + # Styled Error Pages ## What is this? diff --git a/docs/advanced/switch_to_local.md b/docs/advanced/switch_to_local.md new file mode 100644 index 000000000..ff76a7dc2 --- /dev/null +++ b/docs/advanced/switch_to_local.md @@ -0,0 +1,71 @@ +# Switching to Local Storage + +This article discusses what to do if you have media on Google or Dropbox or something and you want to convert to using all local storage. + +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. + +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. + + This would include things like: + + - adding the local storage to the mergerfs + - modifying cloudplow to send new stuff there + +4. Cancel the cloud storage + +The specifics depend on the timetable and how you want to go about it. + +## I want to cut the cord and switch to local all in one fell swoop: + +### Set up your local storage + +Describing how to do this is out of scope for these docs. There are many options here and only you can decide which fit your needs and budget. + +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. + +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: + +``` +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: + +``` +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. + +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. + +Stop all your docker containers. + +Unmount `/mnt/nas` and remove the entry in fstab + +Enter `rclone config` + +Rename your `google` remote to `google-original` + +Create a new remote named `google` that points to your local storage + + - adding the local storage to the mergerfs + - modifying cloudplow to send new stuff there + +### Cancel the cloud storage diff --git a/docs/advanced/tailscale.md b/docs/advanced/tailscale.md index b755d531e..d3585227f 100644 --- a/docs/advanced/tailscale.md +++ b/docs/advanced/tailscale.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - tailscale +--- + # Tailscale Saltbox can integrate its Traefik implementation with [Tailscale](https://tailscale.com) when you have setup Tailscale on the host. diff --git a/docs/advanced/themepark.md b/docs/advanced/themepark.md index e8071dc72..801a9f107 100644 --- a/docs/advanced/themepark.md +++ b/docs/advanced/themepark.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - themepark +--- + # Themepark Styles Saltbox can apply themes from [ThemePark](https://docs.theme-park.dev/theme-options/) to supported applications through the inventory. Applications that can support `cont-init.d` scripts will utilize scripts that modify the CSS within the source files. Support is also available for additional apps via the [Traefik Plugin](https://github.com/packruler/traefik-themepark) which performs CSS replacement at the reverse proxy (rather than application) level. diff --git a/docs/advanced/user-crontab-examples.md b/docs/advanced/user-crontab-examples.md index 503f36b3e..ae6586c63 100644 --- a/docs/advanced/user-crontab-examples.md +++ b/docs/advanced/user-crontab-examples.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - crontab +--- + # Example crontab commands ## Note that these are just some examples, not a list of things that any particular user should have in their crontab diff --git a/docs/advanced/your-own-containers.md b/docs/advanced/your-own-containers.md index 018e512fa..6ea0800f3 100644 --- a/docs/advanced/your-own-containers.md +++ b/docs/advanced/your-own-containers.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - container + - add +--- # Adding your own containers to Saltbox diff --git a/docs/apps/asshama.md b/docs/apps/asshama.md index a7a59a089..5ff098a76 100644 --- a/docs/apps/asshama.md +++ b/docs/apps/asshama.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - asshama +--- + # Absolute Series Scanner and HAMA role for anime ## What is it? diff --git a/docs/apps/authelia.md b/docs/apps/authelia.md index cfaca5fd2..6bfdf12fc 100644 --- a/docs/apps/authelia.md +++ b/docs/apps/authelia.md @@ -5,6 +5,8 @@ tags: - authelia --- +# Authelia + # What is it? [Authelia](https://www.authelia.com/) (Authelia) is an open-source authentication and authorization server and portal fulfilling the identity and access management (IAM) role of information security in providing multi-factor authentication and single sign-on (SSO) for your applications via a web portal. diff --git a/docs/apps/autobrr.md b/docs/apps/autobrr.md index be1088591..14386012a 100644 --- a/docs/apps/autobrr.md +++ b/docs/apps/autobrr.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - autobrr +--- + # Autobrr ## What is it? diff --git a/docs/apps/autoscan.md b/docs/apps/autoscan.md index 379eb89b0..e6aed54ca 100644 --- a/docs/apps/autoscan.md +++ b/docs/apps/autoscan.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - autoscan +--- + # Autoscan ## What is it? diff --git a/docs/apps/bazarr.md b/docs/apps/bazarr.md index 8f9d2303f..5906bdcfc 100644 --- a/docs/apps/bazarr.md +++ b/docs/apps/bazarr.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - bazarr +--- + # Bazarr ## What is it? diff --git a/docs/apps/btrfsmaintenance.md b/docs/apps/btrfsmaintenance.md index 576023295..0b4bc06f6 100644 --- a/docs/apps/btrfsmaintenance.md +++ b/docs/apps/btrfsmaintenance.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - btrfs + - btrfsmaintenance +--- + # BTRFS Maintenance ## What is it? diff --git a/docs/apps/cloudplow.md b/docs/apps/cloudplow.md index 36f34fa9c..fdfa95a79 100644 --- a/docs/apps/cloudplow.md +++ b/docs/apps/cloudplow.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - cloudplow +--- + +# Cloudplow + # What is it? [Cloudplow](https://github.com/l3uddz/cloudplow) (CP) is a script created by [l3uddz](https://github.com/l3uddz) that has one main component as relates to Saltbox: it's an uploader to Rclone remote. Files are moved off local storage. With support for multiple uploaders (i.e. remote/folder pairings). diff --git a/docs/apps/deluge.md b/docs/apps/deluge.md index dad806ea3..0f49c8fa8 100644 --- a/docs/apps/deluge.md +++ b/docs/apps/deluge.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - deluge +--- + # Deluge ## What is it? diff --git a/docs/apps/diun.md b/docs/apps/diun.md index 4db958b41..f3bf0d552 100644 --- a/docs/apps/diun.md +++ b/docs/apps/diun.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - diun +--- + # diun ## What is it? diff --git a/docs/apps/dozzle.md b/docs/apps/dozzle.md index 6fda979e1..b8548df5e 100644 --- a/docs/apps/dozzle.md +++ b/docs/apps/dozzle.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - dozzle +--- + # Dozzle ## What is it? diff --git a/docs/apps/emby.md b/docs/apps/emby.md index c24b119d8..bf625d0b0 100644 --- a/docs/apps/emby.md +++ b/docs/apps/emby.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - emby +--- + +# Emby + # What is it? [Emby](https://emby.media) is a media server designed to organize, play, and stream audio and video to a variety of devices diff --git a/docs/apps/gluetun.md b/docs/apps/gluetun.md index 4178aacf7..54841cb91 100644 --- a/docs/apps/gluetun.md +++ b/docs/apps/gluetun.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - gluetun +--- + # Gluetun ## What is it? diff --git a/docs/apps/grafana.md b/docs/apps/grafana.md index 798c7e53b..7ca005db2 100644 --- a/docs/apps/grafana.md +++ b/docs/apps/grafana.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - grafana +--- + # Grafana ## What is it? diff --git a/docs/apps/hetzner_nfs.md b/docs/apps/hetzner_nfs.md index a8aa7fda2..853d6f5ee 100644 --- a/docs/apps/hetzner_nfs.md +++ b/docs/apps/hetzner_nfs.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - nfs +--- + # Hetzner NFS VLAN ## What is it? diff --git a/docs/apps/jackett.md b/docs/apps/jackett.md index 53432c7e5..6b0b4e1ba 100644 --- a/docs/apps/jackett.md +++ b/docs/apps/jackett.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - jackett +--- + +# Jackett + # What is it? [Jackett](https://github.com/Jackett/Jackett) (based on the original work of Matthew Little aka _zone117x_) is a web-based app that acts like a proxy server, directing search queries from download clients (e.g. Sonarr) to torrent tracker sites and sending the results back. Download clients can also use Jackett to fetch RSS feeds from tracker sites. Finally, it can be used as a meta search tool to find torrents, right from within the app. diff --git a/docs/apps/jellyfin.md b/docs/apps/jellyfin.md index edd2c9ccb..556abc47e 100644 --- a/docs/apps/jellyfin.md +++ b/docs/apps/jellyfin.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - jellyfin +--- + # Jellyfin ## What is it? diff --git a/docs/apps/lidarr.md b/docs/apps/lidarr.md index 3fe46df25..bd4d06d4f 100644 --- a/docs/apps/lidarr.md +++ b/docs/apps/lidarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - lidarr +--- + +# Lidarr + # What is it? [Lidarr](https://lidarr.audio) is basically Sonarr for music. It functions as a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds from Bittorrent trackers and Usenet Indexers, looking for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. diff --git a/docs/apps/mariadb.md b/docs/apps/mariadb.md index 193cd4293..b7b5a85bb 100644 --- a/docs/apps/mariadb.md +++ b/docs/apps/mariadb.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - mariadb +--- + # MariaDB ## What is it? diff --git a/docs/apps/netdata.md b/docs/apps/netdata.md index 1ce6008eb..f6c8f7f61 100644 --- a/docs/apps/netdata.md +++ b/docs/apps/netdata.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - netdata +--- + # Netdata ## What is it? diff --git a/docs/apps/nzbget.md b/docs/apps/nzbget.md index 1bfd01060..d7e31b083 100644 --- a/docs/apps/nzbget.md +++ b/docs/apps/nzbget.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - nzbget +--- + +# NZBGet + # What is it? [NZBGet](https://nzbget.net/) (by Andrey Prygunkov aka hugbug) is a very efficient, cross-platform usenet downloader. diff --git a/docs/apps/nzbhydra2.md b/docs/apps/nzbhydra2.md index 306977ced..76986d2d1 100644 --- a/docs/apps/nzbhydra2.md +++ b/docs/apps/nzbhydra2.md @@ -1,4 +1,12 @@ -THIS PAGE HAS NOT BEEN FULLY UPDATED FOR SALTBOX +--- +hide: + - tags +tags: + - nzbhydra + - nzbhydra2 +--- + +# NZBHydra2 # What is it? diff --git a/docs/apps/organizr.md b/docs/apps/organizr.md index d140859d0..d6755afe0 100644 --- a/docs/apps/organizr.md +++ b/docs/apps/organizr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - organizr +--- + +# Organizr + # What is it? [Organizr](https://organizr.app/) (by CauseFX) is a web-based, HTPC server organizer, that allows you to manage various tools and programs within tabs. Also supports user management, allowing for non admin users or guests to access certain web-pages via Organizr, even if it is behind HTTP authentication. This guide is to help you get Organizr setup and running by no means is this a complete guide to Organizr as you'll see the depth of it is pretty vast and there are plenty of customizations available to you at every turn. diff --git a/docs/apps/overseerr.md b/docs/apps/overseerr.md index 51ba50088..8b5b6e14c 100644 --- a/docs/apps/overseerr.md +++ b/docs/apps/overseerr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - overseerr +--- + +# Overseerr + # What is it? [Overseerr](https://overseerr.dev/) is a request management and media discovery tool built to work with your existing Plex ecosystem. diff --git a/docs/apps/petio.md b/docs/apps/petio.md index 6e0f4b84b..c631c3cd2 100644 --- a/docs/apps/petio.md +++ b/docs/apps/petio.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - petio +--- + # Petio ## What is it? diff --git a/docs/apps/plex-autoscan.md b/docs/apps/plex-autoscan.md index f65629083..abc7aeabb 100644 --- a/docs/apps/plex-autoscan.md +++ b/docs/apps/plex-autoscan.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - plex-autoscan +--- + # Plex Autoscan ## What is it? diff --git a/docs/apps/plex.md b/docs/apps/plex.md index 0a07aa58a..4ad705edb 100644 --- a/docs/apps/plex.md +++ b/docs/apps/plex.md @@ -6,6 +6,8 @@ tags: - pms --- +# Plex + # What is it? [Plex](https://plex.tv/) is a media server. diff --git a/docs/apps/portainer.md b/docs/apps/portainer.md index 7fed821ab..032149010 100644 --- a/docs/apps/portainer.md +++ b/docs/apps/portainer.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - portainer +--- + +# Portainer + THIS PAGE HAS NOT BEEN FULLY UPDATED FOR SALTBOX # What is it? diff --git a/docs/apps/postgres.md b/docs/apps/postgres.md index 43c3ddfb5..7fc00f033 100644 --- a/docs/apps/postgres.md +++ b/docs/apps/postgres.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - postgres +--- + # Postgres ## What is it? diff --git a/docs/apps/prowlarr.md b/docs/apps/prowlarr.md index ef636e7e6..e65dcfe04 100644 --- a/docs/apps/prowlarr.md +++ b/docs/apps/prowlarr.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - prowlarr +--- + # Prowlarr ## What is it? diff --git a/docs/apps/qbittorrent.md b/docs/apps/qbittorrent.md index 03c0eb3ba..e05e96ee2 100644 --- a/docs/apps/qbittorrent.md +++ b/docs/apps/qbittorrent.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - qbittorrent +--- + # qBittorrent ## What is it? diff --git a/docs/apps/radarr.md b/docs/apps/radarr.md index f6d6b4f9d..109c63547 100644 --- a/docs/apps/radarr.md +++ b/docs/apps/radarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - radarr +--- + +# Radarr + # What is it? [Radarr](https://radarr.video/) is a 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. diff --git a/docs/apps/readarr.md b/docs/apps/readarr.md index 54b4ba63d..372e45f6f 100644 --- a/docs/apps/readarr.md +++ b/docs/apps/readarr.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - readarr +--- + # Readarr ## What is it? diff --git a/docs/apps/rutorrent.md b/docs/apps/rutorrent.md index 8e8a208ac..59e3ef273 100644 --- a/docs/apps/rutorrent.md +++ b/docs/apps/rutorrent.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - rutorrent +--- + +# ruTorrent + THIS PAGE HAS NOT BEEN FULLY UPDATED FOR SALTBOX # What is it? diff --git a/docs/apps/sabnzbd.md b/docs/apps/sabnzbd.md index 3becfe126..28e50361a 100644 --- a/docs/apps/sabnzbd.md +++ b/docs/apps/sabnzbd.md @@ -6,6 +6,8 @@ tags: - sabnzbd --- +# SABnzbd + # What is it? [SABnzbd](https://github.com/sabnzbd/sabnzbd) is an Open Source Binary Newsreader written in Python. diff --git a/docs/apps/sonarr.md b/docs/apps/sonarr.md index 2aef3e6bc..8c44c367b 100644 --- a/docs/apps/sonarr.md +++ b/docs/apps/sonarr.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - sonarr +--- + +# Sonarr + # What is it? [Sonarr](https://sonarr.tv/) is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. diff --git a/docs/apps/tautulli.md b/docs/apps/tautulli.md index 2fffb894d..9074bbf59 100644 --- a/docs/apps/tautulli.md +++ b/docs/apps/tautulli.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - tautulli +--- + +# Tautulli + # What is it? [Tautulli](http://tautulli.com/) (Tautulli), by JonnyWong16, is a web-based application runs alongside the Plex Media Server to monitor activity and track various statistics (eg most watched media). diff --git a/docs/apps/transfer.md b/docs/apps/transfer.md index af3aea4f4..f5219dc6b 100644 --- a/docs/apps/transfer.md +++ b/docs/apps/transfer.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - transfer + - transfer.sh +--- + # transfer.sh ## What is it? diff --git a/docs/apps/unpackerr.md b/docs/apps/unpackerr.md index ff3fc8502..480cb5f03 100644 --- a/docs/apps/unpackerr.md +++ b/docs/apps/unpackerr.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - unpackerr +--- + # Unpackerr ## What is it? diff --git a/docs/apps/utility_tags/plex-db.md b/docs/apps/utility_tags/plex-db.md index 350150cf5..17438c176 100644 --- a/docs/apps/utility_tags/plex-db.md +++ b/docs/apps/utility_tags/plex-db.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - plex-db +--- + # Plex DB ## What is it? diff --git a/docs/apps/whisparr.md b/docs/apps/whisparr.md index e89f72b48..c80feca5e 100644 --- a/docs/apps/whisparr.md +++ b/docs/apps/whisparr.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - whisparr +--- + # Whisparr ## What is it? diff --git a/docs/faq/Backup and Restore.md b/docs/faq/Backup and Restore.md index 83bdc413a..a384cef53 100644 --- a/docs/faq/Backup and Restore.md +++ b/docs/faq/Backup and Restore.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - backup + - restore +--- # Backup and Restore diff --git a/docs/faq/Cloud Storage.md b/docs/faq/Cloud Storage.md index 1e3f0a093..1541f9fc5 100644 --- a/docs/faq/Cloud Storage.md +++ b/docs/faq/Cloud Storage.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - cloud + - storage +--- + # Cloud Storage ## Does Saltbox support encrypted data on the cloud? diff --git a/docs/faq/Cloudflare.md b/docs/faq/Cloudflare.md index 717d09a36..b9dcb98bb 100644 --- a/docs/faq/Cloudflare.md +++ b/docs/faq/Cloudflare.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - cloudflare +--- + # Cloudflare --- diff --git a/docs/faq/Cloudplow.md b/docs/faq/Cloudplow.md index 31deefb00..a97312fe3 100644 --- a/docs/faq/Cloudplow.md +++ b/docs/faq/Cloudplow.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - cloudplow + - faq +--- + # Cloudplow FAQs --- diff --git a/docs/faq/Docker.md b/docs/faq/Docker.md index 23f2dec68..927f92484 100644 --- a/docs/faq/Docker.md +++ b/docs/faq/Docker.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - docker + - faq +--- + # Docker ## Why does Saltbox use the Docker network "saltbox" instead of bridge? diff --git a/docs/faq/Hetzner.md b/docs/faq/Hetzner.md index b4dbb3c8e..91fd1db49 100644 --- a/docs/faq/Hetzner.md +++ b/docs/faq/Hetzner.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - hetzner + - ipv6 +--- + # Hetzner & Google IPv6 From time to time Hetzner seems to have problems with IPv6 routing to Google so these are ways you can work around that problem. diff --git a/docs/faq/Install.md b/docs/faq/Install.md index d5bd7f749..41d0e7dbc 100644 --- a/docs/faq/Install.md +++ b/docs/faq/Install.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - install + - faq +--- # Install diff --git a/docs/faq/Misc.md b/docs/faq/Misc.md index aea27d9e1..f1db954d8 100644 --- a/docs/faq/Misc.md +++ b/docs/faq/Misc.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - misc + - faq +--- + # Misc IT IS QUITE PROBABLE THAT SOME INFORMATION HERE IS OUTDATED diff --git a/docs/faq/Plex-Autoscan.md b/docs/faq/Plex-Autoscan.md index 9936b340d..0a9b688e7 100644 --- a/docs/faq/Plex-Autoscan.md +++ b/docs/faq/Plex-Autoscan.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - plex-autoscan + - faq +--- + # Plex Autoscan IT IS QUITE PROBABLE THAT SOME INFORMATION HERE IS OUTDATED diff --git a/docs/faq/Plex.md b/docs/faq/Plex.md index b2ed58e03..1c0f9c6ec 100644 --- a/docs/faq/Plex.md +++ b/docs/faq/Plex.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - plex + - faq +--- + # Plex DO NOT FOLLOW ANY INSTRUCTIONS HERE UNLESS YOU *FULLY* UNDERSTAND WHAT THESE COMMANDS DO. diff --git a/docs/faq/Rclone.md b/docs/faq/Rclone.md index 9ed1c0163..d440a3bac 100644 --- a/docs/faq/Rclone.md +++ b/docs/faq/Rclone.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - rclone + - faq +--- + # Rclone ## Rclone error: Failed to save config file: open /home/\/.config/rclone/rclone.conf: permission denied diff --git a/docs/faq/System.md b/docs/faq/System.md index 987f59fab..5d999d1d2 100644 --- a/docs/faq/System.md +++ b/docs/faq/System.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - system + - faq + - arm +--- + # System ## Can I install this on an ARM machine? @@ -38,7 +47,7 @@ uid=XXXX(yourusername) gid=XXXX(yourgroup) groups=XXXX(yourgroup) ## Change shell of user account to bash -The generally correcct way to do this is to change the setting and run `sb install shell` +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. diff --git a/docs/faq/ruTorrent.md b/docs/faq/ruTorrent.md index ad6e199d2..335997da5 100644 --- a/docs/faq/ruTorrent.md +++ b/docs/faq/ruTorrent.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - rutorrent + - faq +--- + # ruTorrent IT IS QUITE PROBABLE THAT SOME INFORMATION HERE IS OUTDATED diff --git a/docs/reference/accounts.md b/docs/reference/accounts.md index 6a77dd03b..82ed8b859 100644 --- a/docs/reference/accounts.md +++ b/docs/reference/accounts.md @@ -1,3 +1,12 @@ +--- +hide: + - tags +tags: + - accounts + - settings + - advanced +--- + # Accounts and Settings !!! warning diff --git a/docs/reference/cloud.md b/docs/reference/cloud.md index c5b20b1a7..2aae55d25 100644 --- a/docs/reference/cloud.md +++ b/docs/reference/cloud.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - cloud + - storage +--- + # Cloud Storage ## Provider diff --git a/docs/reference/cloudplow-config.md b/docs/reference/cloudplow-config.md index 8e5e8d80d..10553c438 100644 --- a/docs/reference/cloudplow-config.md +++ b/docs/reference/cloudplow-config.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - cloudplow + - config +--- + # Cloudplow Config NOTE: Everything here is specific to Google Drive. If you are using Dropbox, there is nothing here that applies to you. diff --git a/docs/reference/cloudplow.md b/docs/reference/cloudplow.md index d70094d78..6812c6f48 100644 --- a/docs/reference/cloudplow.md +++ b/docs/reference/cloudplow.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - cloudplow + - example +--- + # Example Cloudplow configs ## Cloudplow with Default Config diff --git a/docs/reference/customizing-plex-libs.md b/docs/reference/customizing-plex-libs.md index 63a9abd59..ef70225e6 100644 --- a/docs/reference/customizing-plex-libs.md +++ b/docs/reference/customizing-plex-libs.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - library + - custom +--- + # Customizing Plex Libraries !!! important diff --git a/docs/reference/dependencies.md b/docs/reference/dependencies.md index 92781aca6..81e447f9a 100644 --- a/docs/reference/dependencies.md +++ b/docs/reference/dependencies.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - dependencies + - install +--- + +# Dependencies + !!! warning This is a reference discussing an aspect of the [install process](../saltbox/install/install.md#step-1-dependencies). If you are looking for the steps to follow to install, they are [here](../saltbox/install/install.md). diff --git a/docs/reference/domain.md b/docs/reference/domain.md index 7cfc2c879..f63f90615 100644 --- a/docs/reference/domain.md +++ b/docs/reference/domain.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - domain +--- + ## 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. diff --git a/docs/reference/google-account-perms.md b/docs/reference/google-account-perms.md index 186fa470b..170aa8571 100644 --- a/docs/reference/google-account-perms.md +++ b/docs/reference/google-account-perms.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - google + - permissions +--- + +# Google Permissions + This guide will show you how to verify that your Google account has the correct permissions required for the shared drive creation. It's assuming you're working through the steps from [here](rclone-manual.md). diff --git a/docs/reference/google-gcloud-tools-install.md b/docs/reference/google-gcloud-tools-install.md index ad341c4e1..bfccd0bae 100644 --- a/docs/reference/google-gcloud-tools-install.md +++ b/docs/reference/google-gcloud-tools-install.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - google + - gcloud +--- + # Google GCloud Tools Installation This guide will show you how to set up the Google SDK tools. diff --git a/docs/reference/google-group-setup.md b/docs/reference/google-group-setup.md index 864b4d59c..6c23a030d 100644 --- a/docs/reference/google-group-setup.md +++ b/docs/reference/google-group-setup.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - google + - group +--- + +# Google Group setup + This guide will show you how to set up a Google Group for use with service accounts. It's assuming you're working through the steps from [here](rclone-manual.md) and have completed the following steps: diff --git a/docs/reference/google-project-setup.md b/docs/reference/google-project-setup.md index f8c59840c..8810159eb 100644 --- a/docs/reference/google-project-setup.md +++ b/docs/reference/google-project-setup.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - google + - project +--- + +# Google Project setup + This guide will show you how to set up a Google Project and create credentials that will work for sa-gen or similar tools. It's assuming you're working through the steps from [here](rclone-manual.md) and have completed the following steps: diff --git a/docs/reference/google-service-accounts.md b/docs/reference/google-service-accounts.md index 13eecb1c5..b69bde0ef 100644 --- a/docs/reference/google-service-accounts.md +++ b/docs/reference/google-service-accounts.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - google + - service-accounts + - service + - sa +--- + # Google Service Accounts This guide will show you how to create projects and service accounts using `sa-gen` and add them to a Google Group. diff --git a/docs/reference/google-shared-drives.md b/docs/reference/google-shared-drives.md index 59b051ca4..2e4ffaae4 100644 --- a/docs/reference/google-shared-drives.md +++ b/docs/reference/google-shared-drives.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - google + - shared + - shared-drives + - teamdrive +--- + # Google Shared Drives This guide will show you how to create default Saltbox Shared Drives and add your group of SAs to them. diff --git a/docs/reference/install.md b/docs/reference/install.md index 3d333c367..a3488779f 100644 --- a/docs/reference/install.md +++ b/docs/reference/install.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - install + - installation +--- + # Installation !!! warning diff --git a/docs/reference/local-storage.md b/docs/reference/local-storage.md index 706969eb0..2708f2f72 100644 --- a/docs/reference/local-storage.md +++ b/docs/reference/local-storage.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - local + - storage +--- + # Local Storage 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. diff --git a/docs/reference/logs.md b/docs/reference/logs.md index 38d3abaf0..28940c2ec 100644 --- a/docs/reference/logs.md +++ b/docs/reference/logs.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - logs + - logging +--- + # Apps ## Autoscan diff --git a/docs/reference/multiple-instances.md b/docs/reference/multiple-instances.md index 5723ba204..efb8f5350 100644 --- a/docs/reference/multiple-instances.md +++ b/docs/reference/multiple-instances.md @@ -6,6 +6,7 @@ tags: - radarr4k - sonarrx - sonarr4k + - multiple --- # Multiple App Instances diff --git a/docs/reference/plex-autoscan-config.md b/docs/reference/plex-autoscan-config.md index 217be9253..870a1287e 100644 --- a/docs/reference/plex-autoscan-config.md +++ b/docs/reference/plex-autoscan-config.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - plex-autoscan + - config +--- + +# Plex-Autoscan Config + !!! info NOTE: plex_autoscan is no longer installed in the default Saltbox setup; it has been replaced by Autoscan. Chances are you **do not need** to do this setup. diff --git a/docs/reference/plex-autoscan-extras.md b/docs/reference/plex-autoscan-extras.md index 61c1f20ea..846b9e4c5 100644 --- a/docs/reference/plex-autoscan-extras.md +++ b/docs/reference/plex-autoscan-extras.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - plex-autoscan + - extras +--- + # Plex Autoscan Extras Other options for [Plex Autoscan](https://github.com/l3uddz/plex_autoscan). diff --git a/docs/reference/plex.md b/docs/reference/plex.md index 09f95f1b3..9b4a78a8a 100644 --- a/docs/reference/plex.md +++ b/docs/reference/plex.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - plex + - emby +--- + # Plex or Emby Account ## Plex diff --git a/docs/reference/plex_auth_token.md b/docs/reference/plex_auth_token.md index 5c9369b71..f073757f8 100644 --- a/docs/reference/plex_auth_token.md +++ b/docs/reference/plex_auth_token.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - plex-token + - token +--- + Here is a way of obtaining a Plex Access Token for your Plex account. ## Saltbox Role diff --git a/docs/reference/ports.md b/docs/reference/ports.md index 1deae8bcb..beec784b7 100644 --- a/docs/reference/ports.md +++ b/docs/reference/ports.md @@ -2,8 +2,13 @@ hide: - navigation - toc + - tags +tags: + - port --- +# Saltbox Ports + | **App** | **Ports** | **Notes** | | ----------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | Emby | | | diff --git a/docs/reference/preinstall.md b/docs/reference/preinstall.md index 10c42c4b9..ea78b68ec 100644 --- a/docs/reference/preinstall.md +++ b/docs/reference/preinstall.md @@ -1,3 +1,10 @@ +--- +hide: + - tags +tags: + - pre-install +--- + !!! warning This is a reference discussing an aspect of the [install process](../saltbox/install/install.md#preinstall). If you are looking for the steps to follow to install, they are [here](../saltbox/install/install.md). diff --git a/docs/reference/rclone-auto.md b/docs/reference/rclone-auto.md index 8c494078c..32e129f2e 100644 --- a/docs/reference/rclone-auto.md +++ b/docs/reference/rclone-auto.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - rclone + - automated +--- + ## Automated rclone setup There were initially plans for saltbox to have an automated rclone setup for google drive. diff --git a/docs/reference/rclone-manual.md b/docs/reference/rclone-manual.md index 2e29368c6..24c679910 100644 --- a/docs/reference/rclone-manual.md +++ b/docs/reference/rclone-manual.md @@ -1,3 +1,11 @@ +--- +hide: + - tags +tags: + - rclone + - scripted +--- + # Rclone