Skip to content

Commit 29317a2

Browse files
chazlarsonchazlarson
authored
no more skip-tags, add variable overrides
1 parent b166b41 commit 29317a2

File tree

1 file changed

+48
-26
lines changed

1 file changed

+48
-26
lines changed

‎docs/saltbox/basics/install_types.md

Lines changed: 48 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,59 @@
22

33
Saltbox consists of a "Core" with various extra components added onto that core. At a minimum, you need to install "core" to do anything further with the Saltbox infrastructure.
44

5-
| | `core` | `saltbox` | `mediabox` | `feederbox` |
6-
|:---------------------------------------------------------------------------------------------------------------------|:-------------:|:-------------:|:-------------:|:-------------:|
7-
| System Tweaks | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
8-
| [Saltbox MOTD](https://github.com/saltyorg/motd) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
9-
| Common Tools and Tasks | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
10-
| [Docker](https://www.docker.com/community-edition) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
11-
| [Rclone](https://rclone.org) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
12-
| Mounts: [MergerFS](https://github.com/trapexit/mergerfs) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
13-
| Mounts: [Rclone VFS](https://rclone.org/commands/rclone_mount/#vfs-virtual-file-system) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
14-
| Scripts | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
15-
| [Traefik](https://traefik.io/traefik/) ([Docker](https://hub.docker.com/_/traefik/)) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
16-
| [Authelia](https://www.authelia.com/) ([Docker](https://hub.docker.com/r/authelia/authelia)) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
17-
| [Plex](https://www.plex.tv) ([Docker](https://github.com/plexinc/pms-docker)) | | ![Yes][yes] | ![Yes][yes] | |
18-
| [Tautulli](http://tautulli.com/) ([Docker](https://github.com/Tautulli/Tautulli-Docker)) | | ![Yes][yes] | ![Yes][yes] | |
19-
| [Overseerr](https://docs.overseerr.dev/) ([Docker](https://github.com/sct/overseerr)) | | ![Yes][yes] | ![Yes][yes] | |
20-
| [Autoscan](https://github.com/Cloudbox/autoscan) (Media Scanner Helper Script) | | ![Yes][yes] | ![Yes][yes] | |
21-
| [Portainer](https://portainer.io) ([Docker](https://hub.docker.com/r/portainer/portainer/)) | | ![Yes][yes] | | ![Yes][yes] |
22-
| [Organizr](https://github.com/causefx/Organizr) ([Docker](https://github.com/linuxserver/docker-organizr)) | | ![Yes][yes] | | ![Yes][yes] |
23-
| [Cloudplow](https://github.com/l3uddz/cloudplow) (Media Uploader) | | ![Yes][yes] | | ![Yes][yes] |
24-
| [SABnzbd](https://sabnzbd.org/) ([Docker](https://github.com/hotio/docker-sabnzbd)) | | ![Yes][yes][^1] | | ![Yes][yes] |
25-
| [Qbittorrent](https://github.com/qbittorrent/qBittorrent) ([Docker](https://hub.docker.com/r/saltydk/qbittorrent)) | | ![Yes][yes][^1] | | ![Yes][yes] |
26-
| [Jackett](https://github.com/Jackett/Jackett) ([Docker](https://github.com/hotio/docker-jackett)) | | ![Yes][yes][^1] | | ![Yes][yes] |
27-
| [NZBHydra 2](https://github.com/theotherp/nzbhydra2) ([Docker](https://github.com/hotio/docker-nzbhydra2)) | | ![Yes][yes][^1] | | ![Yes][yes] |
28-
| [Sonarr](https://sonarr.tv) ([Docker](https://github.com/hotio/docker-sonarr)) | | ![Yes][yes] | | ![Yes][yes] |
29-
| [Radarr](https://radarr.video) ([Docker](https://github.com/hotio/docker-radarr)) | | ![Yes][yes] | | ![Yes][yes] |
30-
| [Lidarr](https://lidarr.audio) ([Docker](https://github.com/hotio/docker-lidarr)) | | ![Yes][yes] | | ![Yes][yes] |
5+
| | `core` | `saltbox`[^1] | `mediabox`[^1] | `feederbox`[^1] |
6+
|:---------------------------------------------------------------------------------------------------------------------|:-------------:|:-----------------:|:-----------------:|:-----------------:|
7+
| System Tweaks | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
8+
| [Saltbox MOTD](https://github.com/saltyorg/motd) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
9+
| Common Tools and Tasks | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
10+
| [Docker](https://www.docker.com/community-edition) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
11+
| [Rclone](https://rclone.org) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
12+
| Mounts: [MergerFS](https://github.com/trapexit/mergerfs) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
13+
| Mounts: [Rclone VFS](https://rclone.org/commands/rclone_mount/#vfs-virtual-file-system) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
14+
| Scripts | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
15+
| [Traefik](https://traefik.io/traefik/) ([Docker](https://hub.docker.com/_/traefik/)) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
16+
| [Authelia](https://www.authelia.com/) ([Docker](https://hub.docker.com/r/authelia/authelia)) | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] | ![Yes][yes] |
17+
| [Plex](https://www.plex.tv) ([Docker](https://github.com/plexinc/pms-docker)) | | ![Yes][yes][^2] | ![Yes][yes][^2] | |
18+
| [Tautulli](http://tautulli.com/) ([Docker](https://github.com/Tautulli/Tautulli-Docker)) | | ![Yes][yes] | ![Yes][yes] | |
19+
| [Overseerr](https://docs.overseerr.dev/) ([Docker](https://github.com/sct/overseerr)) | | ![Yes][yes] | ![Yes][yes] | |
20+
| [Autoscan](https://github.com/Cloudbox/autoscan) (Media Scanner Helper Script) | | ![Yes][yes] | ![Yes][yes] | |
21+
| [Portainer](https://portainer.io) ([Docker](https://hub.docker.com/r/portainer/portainer/)) | | ![Yes][yes] | | ![Yes][yes] |
22+
| [Organizr](https://github.com/causefx/Organizr) ([Docker](https://github.com/linuxserver/docker-organizr)) | | ![Yes][yes] | | ![Yes][yes] |
23+
| [Cloudplow](https://github.com/l3uddz/cloudplow) (Media Uploader) | | ![Yes][yes] | | ![Yes][yes] |
24+
| [SABnzbd](https://sabnzbd.org/) ([Docker](https://github.com/hotio/docker-sabnzbd)) | | ![Yes][yes][^3] | | ![Yes][yes][^3] |
25+
| [Qbittorrent](https://github.com/qbittorrent/qBittorrent) ([Docker](https://hub.docker.com/r/saltydk/qbittorrent)) | | ![Yes][yes][^3] | | ![Yes][yes][^3] |
26+
| [Jackett](https://github.com/Jackett/Jackett) ([Docker](https://github.com/hotio/docker-jackett)) | | ![Yes][yes][^3] | | ![Yes][yes][^3] |
27+
| [NZBHydra 2](https://github.com/theotherp/nzbhydra2) ([Docker](https://github.com/hotio/docker-nzbhydra2)) | | ![Yes][yes][^3] | | ![Yes][yes][^3] |
28+
| [Sonarr](https://sonarr.tv) ([Docker](https://github.com/hotio/docker-sonarr)) | | ![Yes][yes] | | ![Yes][yes] |
29+
| [Radarr](https://radarr.video) ([Docker](https://github.com/hotio/docker-radarr)) | | ![Yes][yes] | | ![Yes][yes] |
30+
| [Lidarr](https://lidarr.audio) ([Docker](https://github.com/hotio/docker-lidarr)) | | ![Yes][yes] | | ![Yes][yes] |
3131

3232
[yes]:../../images/check-mark.png
3333

34+
35+
3436
[^1]:
37+
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.
38+
39+
The relevant variables and their default values are:
40+
```
41+
saltbox_roles: ["media_server", "download_clients", "download_indexers", "tautulli", "overseerr", "portainer", "organizr", "sonarr", "radarr", "lidarr", "iperf3", "nethogs", "glances", "btop"]
42+
mediabox_roles: ["media_server", "tautulli", "overseerr", "iperf3", "nethogs", "glances", "btop"]
43+
feederbox_roles: ["download_clients", "download_indexers", "portainer", "organizr", "sonarr", "radarr", "lidarr", "iperf3", "nethogs", "glances", "btop"]
44+
```
45+
46+
[^2]:
47+
Note that the default media server[s] 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.
48+
49+
The relevant variables and their default values are:
50+
```
51+
media_servers_enabled: ["plex"]
52+
```
53+
54+
[^3]:
3555
Note that these default download clients and indexers 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.
56+
57+
The relevant variables and their default values are:
3658
```
3759
download_clients_enabled: ["qbittorrent", "sabnzbd"]
3860
download_indexers_enabled: ["jackett", "nzbhydra2"]

0 commit comments

Comments
 (0)