Saltbox presumes you have a basic understanding of Linux, Docker containers, BitTorrent, and Usenet, and are also familiar with Sonarr, Radarr, NZBGet, rTorrent/ruTorrent, and Plex/Emby.
The Saltbox setup is all done on the command line in the linux shell. There is no GUI and there are no plans to add one. If you want to run Saltbox, you will need to be familiar with Linux.
The guides in this wiki are only meant to setup Saltbox specific settings into the various apps that are installed with Saltbox (e.g. Sonarr, Radarr, Plex, etc) and are not meant to be a full setup for, or an introduction to, the workings of these apps. However, you may pick up a few things as you go thru the guides.
There are, broadly, 4 prerequisites to installing Saltbox:
For best results, the assumed server environment for Saltbox is:
- a dedicated remote x64 [Intel or AMD; ARM NOT SUPPORTED] server [not a VPS],
- from a server provider like Hetzner, OVH, kimsufi, etc.
- freshly installed with Ubuntu Server 20.04 or 22.04,
- nothing else [docker, for example] preinstalled,
- with at least 500GB of disk space, and
- allowing root access
See here for more information about server requirements.
You will need a domain name as Saltbox apps are only accessed via https://appname.yourdomain.com (see Accessing Apps).
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
See here for more information about setting up a domain and DNS settings for use with Saltbox.
A base assumption in Saltbox is that you are storing your media on cloud storage. Saltbox can be set up to use any cloud storage provider that Rclone supports. However, Google Drive via G-Suite Business is the preferred choice among users. Some of the components are designed expressly for Google Drive, like the Google Drive monitoring in plex-autoscan and the service-account rotation in cloudplow.
See here for more information about Cloud Storage requirements and running Saltbox without it.
You'll need a Plex account, if you don't already have one, for purposes of the install, even if you're not planning to use Plex.
This may change in the future, but for now it's a requirement for the simplest Happy Path install described here.
See here for more information about Plex account requirements.
Usenet or Bittorrent sources¶
If you are planning to set up a standard Saltbox or a feederbox, you will need a source of media; Usenet, Torrents, or both
You won't need these particular [media source] details for the initial install, but you will need them for application setup.
See here for more information about media source requirements.
Next, let's discuss Saltbox Install types.