Skip to content

Storage and sync

storage.type can be:

TypeNotes
h2Default. Fast, file-backed, and needs no setup
sqliteFile-backed
mysql or mariadbSet storage.mysql (host, port, database, username, password, pool size)
yamlPlain files

/rr migrate <yaml|h2|sqlite> copies the current data into a sibling folder. After that, change storage.type and restart to switch backends. The command needs rexranks.admin.

Cross-server sync is off by default. Turn on sync.enabled and choose one or more methods in sync.method, for example database,redis:

MethodHow it works
databasePolls updated_at every sync.poll-seconds. Works with MySQL or MariaDB
redisPub/sub, so changes arrive instantly. Configure sync.redis
plugin-messagingNotifies other servers behind the same proxy

/rr sync push and /rr sync pull force a cycle. On a network, give each backend a unique server-name.