Getting Started

swizzin was designed to be an easy to use, modular seedbox solution.

System Requirements

Supported Operating Systems

  • Debian 9/10
  • Ubuntu 16.04, Ubuntu 18.04 and Ubuntu 20.04

Recommended Hardware

  • A KVM VPS or bare metal server is recommended
  • 2+ CPU cores KVM or Intel Atom c2750
  • 4 GB of RAM
  • An x86_64 (64-bit) processor is required

With the exception of a 64-bit processor, these are not hard and fast requirements -- you may find that you're able to get away with running on a weaker CPU or less RAM; however, best performance will be had if the applications you're using have ample resource overhead.

Installation

Quick Start

Make sure you have either curl or wget installed. Pick the command of your choice to get started:

bash <(curl -sL https://git.io/swizzin-setup)

Please note that if you are running Ubuntu and choose to run the initial setup though sudo you should include the -H argument to ensure that your home directory is modified to /root when you sudo up. The installer will take care of this for you, and this should be the only time you need to specify sudo -H before running a swizzin command.

Example:

sudo -H su -c 'bash <(wget -O- -q https://git.io/swizzin-setup)'

Setup

After running the above command, the script will check for updates and install some necessary prerequisites before continuing.

When finished, the installer will ask you a few questions:

  • A username for the master user
  • A password for the master user
  • The packages you would like to install

In text fields, you only need to enter your text and hit return to enter. To choose packages, from the list, you can navigate with the arrow keys. Press space to select an entry. When you're satisfied with your selection, press tab to move the selector to Ok and then press enter. This will advance the screen.

When you have finished running through the prompts, installation will start. The time it takes will depend on the number of packages you have selected.

Additional Setup Quirks

A few items to be aware of as known issues. Most of these have had attempts at working around them, but it's good to be aware of things to avoid:

  • Installer appears frozen before any user input (usually on Installing dependencies or Checking repos): control-c out and apt update && apt upgrade before running the installer.
  • Capital letters in usernames: capital letters should never be used for usernames
  • Usernames which may conflict with a group that already exists: for example, certain images like AWS may have an admin group out of the box. If you try to name your user admin the install will fail in this case.

Additional Help

If you're having troubles with any of the items in the documentation, please first consult the Troubleshooting guide. If that is not enough for you, join us in Discord and we will attempt to help you to our best ability.

If you have found a bug or are having an issue, please open an issue on GitHub.