First step#

Opens a shell in the VivumLab deploy container.
example: ./launch
example dev: ./launch dev
example build: ./launch local, after first build ./launch local start (to skip the build)
NOTE: If you exit out of the docker container you will not be able to run any of the following commands.

Vivumlab Commands#

vlab will list all available commands.
vlab help COMMAND will show help info for the specified command, eg. vlab help service

Core Commands:#

These commands will check or make changes to the core of VivumLab.
For service specific commands, scroll down or click here

deploy#

deploys Vivumlab, useful when a server refresh is needed.
example: vlab deploy

setup#

Set a service up, follow interactive workflow
examples: vlab setup -s jellyfin

service restart#

Restart all enabled services.
example: vlab service restart

service stop#

Restart all enabled services
example: vlab service stop

terraform#

Spin up a cloud server with Terraform.
example: vlab terraform create

terraform destroy#

Destroys servers created by terraform.
example: vlab terraform destroy

update#

Updates all services on the Vivumlab Server.
example: vlab update

Developer tools#

encrypt#

Encrypts the vault.
example: vlab config encrypt --dev

decrypt#

Decrypts the vault
example: vlab config decrypt --dev

edit_raw#

Decrypts, and opens the config file in nano. Encrypts on save.
example: vlab config edit_raw

restore#

Restore a server from backups. Assuming backups were running
example: vlab restore

launch#

Opens a shell on the remote server.
example: vlab ssh launch

track#

Switches you to the specified branch or tag.
examples
(branch): vlab git track --branch=master
(tag): vlab git track --branch=v0.0.1

reboot#

Allows the user to reboot the server.
example: vlab server restart

shutdown#

Allows the user to shutdown the server.
example: vlab server shutdown

find_help#

Tells the user where to find help/ contact the VivumLab Community.
example: vlab find_help

Service Commands#

These are specific to the service declared in the command. These commands should not affect any other service; unless the running of the service depends on another, eg. Authelia.

show#

Presents the specified services documentation, in the terminal.
example (showing Jellyfin): vlab service show -s jellyfin

restart_one#

Restarts the specified service
example (restarting Jellyfin): vlab service restart -s jellyfin

update_one#

Updates the specified service on the Vivumlab server.
example (updating jellyfin): vlab service update -s jellyfin

stop_one#

Restarts the specified service.
example (stopping Jellyfin): vlab service stop -s jellyfin

remove_one#

Removes the specified service on the Vivumlab server.
example (removing Jellyfin): vlab service remove -s jellyfin

reset_one#

Resets the specified service' files on the Vivumlab server.
example (resetting Jellyfin): vlab service reset -s jellyfin