Everything inside the configuration file should follow YAML's syntax. If you're not sure everything is correct, you can validate it here.

For the sake of readability, some configuration options here will be described in the format of example.sftp.path: value, which would look like the following in the configuration file:

<aside> ⚠️ Do not use tabs for spacing, you must use 2 spaces instead!

</aside>

example:
  sftp:
    path: value

What you can't do

You can't re-use the same key in the same level. For example, you can't do this:

key:
  somekey:
~~key:~~ 
  anotherkey: 

Here is another example of re-using the same key in the same level:

key:
  somekey:
  ~~somekey:~~ 
  anotherkey: 

What you can do

You can use the same key on different levels. For example, you can do this:

key:
  somekey:
anotherkey: 
  somekey: 

Here is another example of re-using the same key on different levels:

key:
  somekey:
    somekey: 
anotherkey: 

A small caveat

Sometimes when a key has no value(s) set, it will normally have a []. This is most common when there are place-holder values, for example under the SFTP section. Here's the docker section of the WISP configuration file, with the registry & docker keys.

docker:
  socket: /var/run/docker.sock
  container:
    user: 999
  autoupdate_images: true
  registry: []
  network: []

Using the example above, if you wanted to use host networking in Docker, you would remove the [] highlighted in yellow above, before adding the name: host key and value under the network key. It would look like this once done.

docker:
  socket: /var/run/docker.sock
  container:
    user: 999
  autoupdate_images: true
  registry: []
  network:
    name: host

View all available guides, chat with the WISP community on Discord and open a support ticket should you require assistance.