-
Notifications
You must be signed in to change notification settings - Fork 3
Configuration
Before first run be sure to copy config-example.json to config.json and change the contents accordingly
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:
jsonsqlitemysql
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.
A String which shows up directly underneath the server logo to help users confirm they are connecting to the correct server.
A locally hosted image to use as the server logo. Must be relative to the server root directory named "public"
Which Default Image to use when the user has not set a gravatar.
One of mp, identicon, monsterid, wavatar, retro, robohash, blank
Options may be added or removed by Gravatar.
A list of strings. Each of these are extra plugins loaded from /plugin to add extra features to the server
Some options can be set by environment variable.
The username to use to connect to the MySQL server
The password to use to connect to the MySQL server
The database to use in the MySQL server
The host on which the MySQL Server is running
Specifically used by the yarn test to ensure MySQL tests are run too. Considered true if set to any value