Before we start

To edit the configuration, you need to understand how the YAML format works. It's pretty simple, and we have a brief guide below:

Understanding the YAML Format

Configuration location

/var/lib/wisp/daemon/config/wisp.yaml ⚠ Apply your changes with wisp restart

<aside> ℹ️ Some changes require you to edit the docker configuration in /var/lib/wisp/docker-compose.yml

</aside>

Using the beta branch

If you'd like to help us test daemon-specific features before they roll out to production, you can move to the beta branch on a specific node.

/var/lib/wisp/docker-compose.yml

environment:
- ENVIRONMENT: beta

Like any changes to the config files, you will need to reboot the daemon for them to take effect.

Changing WISP ports

You can change the default port of the daemon and SFTP in the Admin Panel → Service Management → Nodes → Settings → Configuration tab. This will automatically update the daemon's configuration to the new ports, but you'll need to manually update them if it fails. Like any changes to the config files, you will need to reboot the daemon for them to take effect.

/var/lib/wisp/daemon/config/wisp.yaml

web:
  listen: ...
sftp:
  port: ...

/var/lib/wisp/docker-compose.yml

services:
  bootstrapper:
    ports:
    - '8080:8080'
    - '2022:2022'

Changing console prefix

You can change the [WISP] prefix in the console when a server is starting up by adding the display_name key. You will need to reboot the daemon for changes to take effect.

/var/lib/wisp/daemon/config/wisp.yaml

display_name: "WASP"

Backups

Currently, we have two backup drivers: filesystem for local backups or s3 for remote backups. Like any changes to the config files, you will need to reboot the daemon for them to take effect.

Filesystem

You can change the directory local backups are stored in. After changing the directory, you will need to copy any existing backups from the old directory to the new one.

/var/lib/wisp/daemon/config/wisp.yaml

backup:
  driver: filesystem
  drivers:
    filesystem:
      dir: /home/wisp/...

<aside> ⚠️ If the directory is outside /home/wisp, you'll need to update the volumes in /var/lib/wisp/docker-compose.yml to contain the new location, or the backups won't persist.

</aside>