This document explains how to configure Sider database connections. Sider requires MySQL as a database server. You have to set up three databases because each of Sider’s components,
setaria, needs a dedicated database.
Sider requires MySQL 5.7. You cannot use MySQL 5.6 or older. MySQL 8.0 may work, but we do not support the use of this version.
Sider components assume the following.
- The user account which is used to connect to the database can create a database.
max_allowed_packetis big enough for performance. (We recommend setting the value larger than 20 MB.)
The database load of Sider is not that heavy but consumes a fair amount of storage. We provide Sider SaaS on three AWS RDS instances with:
- sideci: 8 GB of RAM, 100 GB of storage
- catpost: 4 GB of RAM, 100 GB of storage
- setaria: 8 GB of RAM, 200 GB of storage
In most cases, starting with three databases on a computer with 16 GB of RAM and 200 GB of storage or less is enough.
The database configurations are given through
DATABASE_URL environment variable. The URL should have
mysql2 schema, and usually contains username and password. The path component of the URL is the name of the database.
The following URL is an example.
It contains a username and password as
topsecret. The hostname of the database is
mysql.local. If the port number is omitted, the default
3306 will be used. The name of the database is
Any database name can be used, but usually, you don't have to change the names from
You can optionally specify parameters as query parameters. One of the most commonly used one for Sider is
The Sider Docker images ship with a
.pem file for SSL connection to AWS RDS databases at
config/rds-combined-ca-bundle.pem. If you need another
.pem file or option to configure SSL for your MySQL server, use a volume mount to make the file accessible from the container and specify the path to the file.
DATABASE_URL is interpreted by ActiveRecord and mysql2 libraries. You can consult with the documentation of the two libraries.
- ActiveRecord https://github.com/rails/rails/tree/master/activerecord
- mysql2 https://github.com/brianmario/mysql2
# When you are using your own MySQL server DATABASE_URL=mysql2://user:password .local/sideci
# When you are using AWS RDS MySQL server DATABASE_URL=mysql2://user:firstname.lastname@example.org/sideci?sslca=config/rds-combined-ca-bundle.pem
# When you are using your own MySQL server DATABASE_URL=mysql2://user:password .local/catpost
# When you are using AWS RDS MySQL server DATABASE_URL=mysql2://user:email@example.com/catpost?sslca=config/rds-combined-ca-bundle.pem
# When you are using your own MySQL server DATABASE_URL=mysql2://user:password .local/setaria
# When you are using AWS RDS MySQL server DATABASE_URL=mysql2://user:firstname.lastname@example.org/setaria?sslca=config/rds-combined-ca-bundle.pem