Solifex Studios
Browse the wiki

Setup

Database

SQLite by default — zero setup. Switch to MySQL or MariaDB for a shared network store.

DiscordSynthesis stores linked accounts, reports, stats, and reward progress in a database. The default, SQLite, is a single file and needs no setup at all.

SQLite (default)

Nothing to configure — the plugin creates database.db inside its folder. This is the right choice for a single server.

yamlconfig.yml
database:
  # SQLITE, MYSQL, or MARIADB
  type: SQLITE

MySQL / MariaDB

Use a shared database when you run a network and want every server (and the proxy) reading the same links and reports. Create the database first, then point the plugin at it.

yamlconfig.yml
database:
  type: MYSQL              # or MARIADB
  host: localhost
  port: 3306
  database: discordsynthesis
  username: root
  password: ''
  useSSL: false
database options
typedefault: SQLITE
SQLITE, MYSQL, or MARIADB. The keys below only apply to MySQL/MariaDB.
hostdefault: localhost
Database server hostname or IP.
portdefault: 3306
Database port.
databasedefault: discordsynthesis
The schema/database name — create it before starting.
usernamedefault: root
Database user. It needs full rights on that schema.
passworddefault: empty
The user's password.
useSSLdefault: false
Connect over SSL.

Caching

The plugin caches reads and flushes writes on a timer — cachedDatabaseSyncTimer in config.yml (default 60s; 60 or higher is recommended). This keeps hot paths off the database.

Heads up

On a network, every server and the proxy must point at the same MySQL/MariaDB database, or links won't be shared across servers.