Skip to content

docs.saltbox.dev

User

Initializing search

Saltbox
Getting Started
Applications
FAQ
Advanced
Reference
Community

docs.saltbox.dev

Saltbox
Getting Started
Getting Started
- Basics
- Prerequisites
- Install Types
- Installation
- Post-installation
- Update
- Accessing Apps
- Paths
- Major Upgrade Guide
  Major Upgrade Guide
  - Role Refactor
- Inventory
  Inventory
  - Example Overrides
  - Danger Zone
- Backup/Restore
  Backup/Restore
- Sandbox
Applications
Applications
- Saltbox Selection
  Saltbox Selection
  - Plex Media Server
  - Tautulli
  - Autoscan
  - SABnzbd
  - NZBHydra2
  - qBittorrent
  - Jackett
  - Sonarr
  - Radarr
  - Lidarr
  - Overseerr
  - Portainer
  - Organizr
  - btop
  - Glances
  - iPerf3
- Saltbox Expanded
  Saltbox Expanded
  - ASSHAMA
  - Authelia
  - Authentik
  - Autobrr
  - Autoheal
  - Bazarr
  - BTRFS Maintenance
  - cAdvisor
  - Cloudplow
  - CrowdSec
  - ctop
  - DDClient
  - DDNS
  - Deluge
  - Diun
  - Docker CE
  - Docker Socket Proxy
  - Dozzle
  - Emby
  - Error Pages
  - Gluetun
  - Grafana
  - Jellyfin
  - LLDAP
  - Mainline
  - MariaDB Server
  - MongoDB
  - Netdata
  - NGINX
  - Node Exporter
  - NZBGet
  - NZBThrottle
  - Petio
  - PostgreSQL
  - PostgreSQL Host
  - Prometheus
  - Prowlarr
  - Python
  - Rclone
  - Redis
  - ruTorrent
  - Scrutiny
  - Subliminal
  - Traefik Proxy
  - transfer.sh
  - Unpackerr
  - Whisparr
  - yq
- Sandbox (community)
  Sandbox (community)
  - A-Train
  - Actual Budget
  - AdGuard Home
  - Adminer
  - AirDC++
  - Airsonic-Advanced
  - Apprise API
  - ArchiveBox
  - Audiobookshelf
  - BarcodeBuddy
  - Beets
  - BookStack
  - Calibre
  - Calibre-Web
  - changedetection.io
  - Cherry
  - Headless Chromes
  - Cockpit
  - code-server
  - Codex
  - ComiXed
  - Crafty Controller
  - Dashdot
  - Dashy
  - Deemix
  - DelugeVPN
  - DiscoFlix
  - Dockwatch
  - Doplarr
  - Duplicati
  - Elasticsearch
  - EmbyStat
  - EPMS
  - ESPHome
  - Factorio
  - FileBot
  - File Browser
  - FileZilla
  - Firefly III
  - Firefly III Importer
  - Firefox
  - FlareSolverr
  - Forgejo
  - Foundry
  - FreshRSS
  - Funkwhale
  - Gaps
  - Gitea
  - Glances web
  - GoAccess
  - gotenberg
  - Gotify
  - Grocy
  - Guacamole
  - HandBrake
  - Healthchecks
  - Heimdall
  - Homarr
  - Home Assistant
  - Homebox
  - Homepage
  - Immich
  - InfluxDB
  - InfluxDB2
  - InvoiceNinja
  - IT Tools
  - JDownloader
  - Jellyseerr
  - Jellystat
  - Joplin
  - Karakeep
  - Kavita
  - kcptun Client
  - kcptun Server
  - Kitana
  - Koel
  - Kometa
  - Komga
  - Krusader
  - LazyLibrarian
  - LinuxGSM
  - Linkding
  - LinkWarden
  - Maintainerr
  - MakeMKV
  - Maybe Finance
  - Mealie
  - Medusa
  - Meilisearch
  - Membarr
  - Minecraft
  - Minecraft Bedrock
  - Miniflux
  - MKVToolNix
  - Monitorr
  - MovieMatch
  - MQTT
  - Mylar3
  - n8n
  - Nabarr
  - Navidrome
  - Nextcloud
  - Node Red
  - Notifiarr Client
  - OliveTin
  - Ombi
  - OpenObserve
  - Paperless AI
  - Paperless NGX
  - pgAdmin
  - Photoprism®
  - phpMyAdmin
  - Plex Auto Languages
  - Plex DupeFinder
  - Plex Patrol
  - Plex Utills
  - PlexShare
  - Plex-Trakt-Sync
  - PrivateBin
  - Profilarr
  - Puddletag
  - PufferPanel
  - pyload-ng
  - Python-PlexLibrary
  - qBit Manage
  - arch-qbittorrentvpn
  - qui
  - Recyclarr
  - reposilite
  - Requestrr
  - Resilio Sync
  - rFlood
  - Rocket.Chat
  - SABThrottle
  - Semaphore UI
  - Speedtest
  - SQLite Browser
  - Sshwifty
  - Stash
  - Syncthing
  - Tandoor Recipes
  - Tauticord
  - Tdarr
  - Tdarr Node
  - Telegraf
  - Teslamate
  - The Lounge
  - Threadfin
  - tika
  - tqm
  - Trackarr
  - Zig robots.txt
  - Transmission
  - Transmission VPN
  - Trilium Notes
  - Tube Archivist
  - Tvheadend
  - UniFi
  - Unmanic
  - Uptime Kuma
  - Varken
  - vaultwarden
  - vnStat Dashboard
  - WatchState
  - Wikijs
  - Wireguard
  - Wizarr
  - WordPress
  - Wrapperr
  - XBackBone
  - xTeVe
  - Yacht
  - Your Spotify
  - ytdl-sub
  - ZNC
FAQ
FAQ
- System
- Cloud Storage
- Cloudflare
- Cloudplow FAQs
- Docker
- Hetzner & Google IPv6
- Installation
- Backup and Restore
- Rclone
- Plex
- ruTorrent
- Misc
- Bazarr
Advanced
Advanced
Reference
Reference
- Guides
  Guides
  - General
    General
    
    Chazlarson Guides
    Chazlarson Guides
    
    Can I run Saltbox on this server?
    
    Did my Saltbox install succeed?
    
    How do I mount a cloud drive?
    
    I can’t see my media
    
    Why is my disk full?
    
    Installing Saltbox on a home server
  - Linux
    Linux
    
    Saltbox Aliases
  - Plex
    Plex
    
    Tautulli Custom Scripts
  - Downloading
    Downloading
    
    Hardlinking Guide
  - Google
    Google
    
    Creating a Google Shared Drive
  - Dropbox
    Dropbox
    
    General Dropbox Topics
  - Rclone
    Rclone
    
    Creating an Rclone remote
    
    Creating an rclone remote for Dropbox
    
    Creating an rclone remote for Google Drive
    
    Creating an encrypted rclone remote
  - Migration
    Migration
    
    Migrating from one cloud provider to another
  - Further Reading and Links
    Further Reading and Links
    
    Suggested Reading
    
    Links
    
    Migrating from arbitrary setups to Saltbox
- Topics
  Topics
  - Prerequisite References
    Prerequisite References
    
    Server Requirements
    
    Domain
    
    Cloud Storage
    
    Plex or Emby Account
    
    Usenet vs Bittorrent
  - Install References
    Install References
    
    Dependencies
    
    Accounts and Settings
    
    Preinstall
    
    Rclone cloud storage setup
    
    Rclone Manual
    
    Installation
  - Google References
    Google References
    
    Google Permissions
    
    Google Project setup
    
    Google Group setup
    
    Google GCloud Tools Installation
    
    Google Service Accounts
    
    Google Shared Drives
  - Application References
    Application References
    
    Removing apps
    
    Resetting apps
    
    Updating apps
  - Other References
    Other References
    
    Autoscan rewrites
    
    Example Cloudplow configs
    
    Customizing Plex Libraries
    
    Viewing Logs
    
    Multiple App Instances
    
    Shared-Drive Cloudplow Setup
    
    Plex Auth Token
    
    Saltbox Ports
    
    Tools installed by Saltbox
    
    Adding a Subdomain
    
    Using Local Storage
    
    Mounting a disk persistently on your saltbox server
    
    Enabling hardware transcoding on OVH
- Saltbox Modules
  Saltbox Modules
  - Arr DB
  - Common
  - Custom
  - Diag
  - Download Clients
  - Download Indexers
  - Hetzner NFS VLAN
  - Hetzner VLAN
  - Kernel
  - Main Tag
  - Main Tags
  - Media Server
  - MOTD
  - Mount Templates
  - Fix Permissions
  - Plex Auth Token
  - Plex DB
  - Plex Fix Futures
  - Reboot
  - Remote
  - Saltbox Mod
  - Shell
  - System
  - Traefik File Template
  - Traefik Template
  - UnionFS
  - User User
    Table of contents
    
    Overview
    
    Deployment
Community
Community
- Contributing
  Contributing
  - Development
  - Documentation
- Requesting
  Requesting
  - Features
  - Support

Table of contents

Overview
Deployment

User¶

Overview¶

Creates and configures your user account.

Deployment¶

Saltbox dependency.

sb install user

December 1, 2025 November 7, 2025

keldian