Getting Started
Box is a homegrown application that helps you install and manage applications on your server.
Introduction
To use the installer and management functions on your slot, you'll need to use the included management script: box.
Box offers several functions, which are outlined below:
- help
- install
- remove
- update
- upgrade
- adduser
- deluser
- chpasswd
- list
- test
WARNING: Since Box is a complete management script, its functions require root/sudo permissions to execute. This guide assumes you are either a root user or prefixing commands with sudo.
Box
Running box alone starts a guided tutorial with install and remove options for available applications. This is intended for users unfamiliar with Swizzin or Linux. Most users will find install, remove, and upgrade more useful after the initial setup.
Syntax:
box
Help
Provides basic information and usage examples for all available Box commands.
Syntax:
box help
Install
Installs applications on the server. You can specify multiple applications to install simultaneously.
Syntax:
box install rtorrent deluge
Remove
Removes applications from the server. You can specify multiple applications to remove simultaneously.
Syntax:
box remove rtorrent deluge
Update
Updates to the latest Swizzin release and applies configuration fixes to already installed applications. This typically fixes installation issues. Note: This does not upgrade application versions; see the upgrade function for that.
Syntax:
box update
Upgrade
Upgrades a specific application to a newer version or recompiles applications without versions to install the latest fixes. Only some applications have upgrade scripts, and their name is required for upgrading.
Syntax:
box upgrade nginx
Adduser
Adds additional users to your server. Note that only the primary user has access to a significant portion of applications.
Syntax:
box adduser newusername
Deluser
Removes a user from your server. Use with caution, as all user data will be destroyed.
Syntax:
box deluser oldusername
Chpasswd
Changes a user password for SSH, FTP, HTTP, Deluge, and most other applications. Specify chpasswd followed by the username.
Syntax:
box chpasswd username
List
Lists and describes all applications currently available for installation.
Syntax:
box list
Test
Intended for Swizzin developers. It performs sanity checks on the status of installed applications.
Syntax:
box test # Tests all installed appsbox test sonarr radarr # Tests only specified app(s)