Ombi supports multiple database types.
The way this works is that Ombi looks for a database.json file in the installation directory (or, if you specified a Storage Path at startup, in that location e.g. AppData). If the file is not found then Ombi falls back to the default, with SQLite databases in the Ombi directory.
The database.json file need to look like the below example (replacing usernames, passwords, and server addresses to match your own mysql server as needed).
{
"OmbiDatabase": {
"Type":"MySQL",
"ConnectionString":"Server=192.168.1.7;Port=3306;Database=Ombi;User=ombi;Password=ombi"
},
"SettingsDatabase": {
"Type":"sqlite",
"ConnectionString":"Data Source=C:/tmp/Settings.db"
},
"ExternalDatabase": {
"Type":"sqlite",
"ConnectionString":"Data Source=C:/tmp/External.db"
}
}
As you can see you can specify a database type and a connectionstring per database that Ombi has. You can see what each database is used for here.
Supported Databases
| Type | ConnectionString Example |
|---|---|
| SQLite | Data Source=C:/tmp/Ombi.db |
| MySQL/MariaDB | Server=localhost;Database=Ombi;User=root;Password=123456; |
MySql/MariaDB
Supported versions: https://github.com/PomeloFoundation/Pomelo.EntityFrameworkCore.MySql#supported-dbms-and-versions
Please ensure that your database character set is set to utf8mb4. You can check your db charset by running the following query: show variables like 'character_set_database';
You can also point all of them at the same database, as each table has a unique name regardless (as below):
Single Database
{
"OmbiDatabase": {
"Type": "MySQL",
"ConnectionString": "Server=localhost;Port=3306;Database=Ombi;User=ombi;Password=ombi"
},
"SettingsDatabase": {
"Type": "MySQL",
"ConnectionString": "Server=localhost;Port=3306;Database=Ombi;User=ombi;Password=ombi"
},
"ExternalDatabase": {
"Type": "MySQL",
"ConnectionString": "Server=localhost;Port=3306;Database=Ombi;User=ombi;Password=ombi"
}
}
The above example shows using a single mysql "ombi" database for all ombi databases.
It is recommended to use separate databases for each, as it is much easier to drop a database than to drop specific tables.
Multiple Databases
{
"OmbiDatabase": {
"Type": "MySQL",
"ConnectionString": "Server=localhost;Port=3306;Database=Ombi;User=ombi;Password=ombi"
},
"SettingsDatabase": {
"Type": "MySQL",
"ConnectionString": "Server=localhost;Port=3306;Database=Ombi_Settings;User=ombi;Password=ombi"
},
"ExternalDatabase": {
"Type": "MySQL",
"ConnectionString": "Server=localhost;Port=3306;Database=Ombi_External;User=ombi;Password=ombi"
}
}
Create database and user in the server MySql/MariaDB
On the MySQL/MariaDB server we will create the database and the user that we will use later.
You need to GRANT ALL PRIVILEGES for every database you create.
This is done in the mysql console.
A Single Database
CREATE DATABASE IF NOT EXISTS `Ombi` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
CREATE USER 'ombi'@'%' IDENTIFIED BY 'ombi';
GRANT ALL PRIVILEGES ON `Ombi`.* TO 'ombi'@'%' WITH GRANT OPTION;
In Multiple DataBases or Servers MySql/MariaDB
CREATE DATABASE IF NOT EXISTS `Ombi` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
CREATE DATABASE IF NOT EXISTS `Ombi_Settings` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
CREATE DATABASE IF NOT EXISTS `Ombi_External` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
CREATE USER 'ombi'@'%' IDENTIFIED BY 'ombi';
GRANT ALL PRIVILEGES ON `Ombi`.* TO 'ombi'@'%' WITH GRANT OPTION;
GRANT ALL PRIVILEGES ON `Ombi_Settings`.* TO 'ombi'@'%' WITH GRANT OPTION;
GRANT ALL PRIVILEGES ON `Ombi_External`.* TO 'ombi'@'%' WITH GRANT OPTION;
So long as your database.json exists and connects to a mysql server, and the databases and user exists, restarting ombi should generate the tables and start up ombi like it would normally.
This will not migrate any existing settings.
You effectively have a clean ombi install.
You can migrate the existing sqlite databses to mysql if you choose by following the Migration Guide
The wiki is dead! Long live the wiki!