Skip to content

Configuration

trigg edited this page Jun 4, 2021 · 1 revision

Setup

Before first run be sure to copy config-example.json to config.json and change the contents accordingly

storage

You can choose which storage backend is used by this instance. Each backend has distinct advantages and disadvantages and comparing these is beyond the scope of this page.

Currently working backends:

  • JSON
  • SQLite

Currently in work:

  • MySQL

port

Which port to run this server on. We default to 9000 but the server connects using HTTPS and WSS, so binding port 443 allows omitting the port number in the URL.

servername

A String which shows up directly underneath the server logo to help users confirm they are connecting to the correct server.

serverimg

A locally hosted image to use as the server logo. Must be relative to the server root directory named "public"

gravatarfallback

Which Default Image to use when the user has not set a gravatar.

plugins

A list of strings. Each of these are extra plugins loaded from /plugin to add extra features to the server

url

The external hostname & optionally port to access content from. This needs to match how users are connecting in, as it's used to create Fully-qualified URLs

Clone this wiki locally