Next Step#

Once you are all setup and ready to go you should be able to load SUI at [https://sui.vivumlab.xyz/].

Securing Services#

If you want to add an extra layer of authentication to a service, all you have to do is set vlab service <service> auth -v true. Once this is set, authentication will be handled outside of the service.

This is useful, if the service doesn't provide authentication, eg. SUI. and you would like it to be protected.

By default Traefik handles authentication, if the <service>.auth is set to true. More specialised and full featured options are available, check out your options here.

File locations#

VivumLab sets up /home/root/vivumlab on your server, which maps to /home/<ssh_user> by default. All data used to set up your services, can be found here.

If you can't find what you are looking for there; large databases, media collections (audio and video) are typically stored in the "/mnt/nas", which defaults to /mnt/nas. Using NAS storage? see NAS for more information.

HTTPS via LetsEncrypt#

VivumLab will use Traefik's built in LetsEncrypt integration to automatically generate SSL certificates for your various services.

If initially some of the certificates don't appear valid, you have likely run into LetsEncrypt rate limits.

This is LetsEncrypts way of keeping LetsEncrypt usage fair, and as such does not have a fix. Limits will reset in a week. see here

SMTP#

In order for your applications to be able to utilise email (confirmation emails, etc), you need an SMTP server. A nice free one is Mailgun.

Create an account, and follow their steps to register your domain.

Once that is completed, you can plug the settings they provide into your settings/encrypted.yml file. To do this:

  1. run the vlab config decrypt --dev command
  2. find and edit the decrypted.yml file

    NOTE: editing this file may require superuser/ root permissions

  3. Set the following settings to what you have been provided
# SMTP Settings
smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. Now, edit the settings/decrypted.yml file, and set:
mailu:
forward_to_smtp: False

to ...

mailu:
forward_to_smtp: True

This will allow mailu (and every other VivumLab service) to use the mail gun SMTP server

  1. Save, and run vlab deploy to finalise any changes.