Skip to main content

Setting up swizzin with advanced options

Below are the many ways you can use the installer to get exactly to where you need to be, fast.

Note

Not all the code such as package installers has been modified yet to be compatible with the unattended setup and environment variable importing.

If you find some application that is breaking the unattended setup or has no Install options, please raise a GitHub issue.

Options​

danger

Please note that none of the values that you set here are checked for validity or comaptibility. Make sure you programatically check them before. Setting wrong values here could break your system.

--unattend​

  • Disables interactive queries within the setup.sh script such as the greeting and installation applications queries.
  • Does not disable interactive queries within package installers, as those are disabled based on whether environment variables are set.
    • If you find some interactive elements you can't seem to work around, please open an issue on github.

--user​

  • Takes the username of the master user for swizzin to create as positional argument (i.e. --user masteruser)
  • Setting this flag will disable the greeting popup during installation

--pass​

  • Takes the password of the master user for siwzzin to create as positional argument (i.e. --pass 'P@55w0rd')
  • To generate a random password, use --pass ""
  • Shell variables will expand when not in single quotes!
  • Setting this flag will disable the greeting popup during installation
  • Same as --password

--domain​

  • Takes domain as positional argument (i.e. --domain domain.tld)
  • In the event letsencrypt is being installed, this will set the domain against which to verify, enable the certificate in the default nginx config, and skip cloudflare integration
  • Please note: This does not imply that nginx and letsencrypt will be installed, you still have to pass those as packages to install in order for this to apply.

--local​

  • Instead of cloning the repository to /etc/swizzin/, it will link the folder where setup.sh is located to /etc/swizzin.
  • Note: If you (re)move the folder where setup.sh was sitting, the link will break, and so will your box commands etc.

--env​

  • Takes a path to file as positional argument (e.g. --env /path/to/env/file.env)
  • Ingests variables and settings from a file for use later through the installer.Please see the Env File Chapter below
  • Using this implies using --unattend
  • If --env is specified after other arguments, contents of env file will override the arguments. If arguments are specified after the --env file, they will override the content of the env file.
    • if you do bash setup.sh --env /path/to/file.env --user otheruser, all of the env file contents will be ingested, and then the user will be overridden to otheruser
    • The only exception to this are the packages specified on the CLI. If they are specified after the --env, they will get added to the list.

--post-command​

  • Takes a string variable with commands to execute at the end of the installation script

--tests​

  • When set, all packages will be tested using box test after the installation.

[package(s)]​

  • Any other arguments are treated as a name of a swizzin package to install.
  • The order of packages matters, if a package requires another as a dependency and its absence would make an installer fail, make sure to put the dependency first
    • e.g. when installing ruTorrent, you need to ensure that both nginx and rtorrent come before rutorrent, as the installation of that package will fail.
  • If any package is specified, the application installation picker will be skipped during the installation
  • If you want no packages to be installed, make sure to specify the --unattend flag

Environment variables​

  • You can pass environment variables to the script either through...
    • export within your shell before running bash setup.sh
    • you can use something like var1=value var2=value bash setup.sh
  • Same options are available as are for the env file.

Env file​

danger

Please note that none of the values that you set here are checked for validity or comaptibility. Please test your env file thoroughly before deployment.

You can use a file with recorded variables for setup.sh to use, instead of using the CLI arguments/variables. Please see the --env option in the chapter above.

An example file is included in the root of the swizzin git repo.

If a package has an "Install Options" chapter, you can specify those values in this file. Please note that these options can change over time. An example of these can be found here, or in the source code.

Please take these precauttions into account:

  • Some variables gett exported, some only sourced
    • Variables starting with caps ([A-Z]) will get exported
    • Variables starting with miniscules ([a-z]) will get sourced
    • Please make sure to read the env file example in the repo, and the docs of the application you intend to configure
  • You cannot set the option to make a local install in an env file, you will need to append --local on the command line.
# SETUP.SH OPTIONS
## master user setup
user=test
pass=test123
## symlink local swizzin folder to /etc/swizzin/ instead of cloning from upstream
local=true
## packages to install separated by colons.
## **The order of packages matters**, if a package requires another as a dependency and its absence would make an installer fail, make sure to put the dependency first
packages=nginx:panel:transmission:letsencrypt
## run `box test` for all installed testable packages
test=true
# PACKAGE SPECIFIC OPTIONS
## LetsEncrypt options ((https://docs.swizzin.ltd/applications/letsencrypt#install-options))
LE_hostname="domain.tld"
LE_defaultconf=yes
# LE_bool_cf=no if you don't want to use any cloudflare
LE_cf_api=aaapppiiiikkkeeeeeyyyyyyyy
LE_cf_email="email@blach.lol"
LE_cf_zone="some.zone.asdasdasdasd" # or LE_cf_zoneexists=yes if you don't need it created

Examples​

A fully automated install with everything in an env file, and user and password which override the env file

bash <(wget -qO - s5n.sh) \
--env /path/to/file.env --user tester --pass tester123

Quickly get a local environment with a user installed, using your local fork clone instead of upstream, and no apps installed

git clone <your fork>
bash /path/to/swizzin/setup.sh --user tester --pass tester123 --local --unattend

Get a quick transmission installation

arg_transmissionsource="Repo" \
bash <(wget -qO - s5n.sh) \
--user tester --pass tester123 transmission

Get the Dan Martini(TM) (A username, password, domain, nginx and letsencrypt only. Shaken, not interrupted)

bash <(wget -qO - s5n.sh) \
--unattend --user tester --pass tester123 --domain testing.com nginx letsencrypt

The sausage multipass developer menu (this definitely is not me just saving my command recipe for later)

multipass delete --all --purge; multipass launch -n swiz; \
multipass mount .\Git\Fun\swizzin\ swiz:/home/ubuntu/swizzin; \
multipass exec swiz -- sudo -H su -c 'bash /home/ubuntu/swizzin/setup.sh --unattend --local --user test --pass tester123'