diff --git a/docs/source/smui/config.rst b/docs/source/smui/config.rst index 99aecb6..5e6be1e 100644 --- a/docs/source/smui/config.rst +++ b/docs/source/smui/config.rst @@ -75,6 +75,40 @@ using environment variables: - Encryption key for server/client communication (Play 2.6 standard). This positively needs to be set to a high-entropy value in production environments. - **WARNING:** insecure default. + +MySQL Details +~~~~~~~~~~~~~ + +The below settings assume you have a database named `smui` created on your localhost. + +:: + + SMUI_DB_URL=jdbc:mysql://localhost:3306/smui?autoReconnect=true&useSSL=false&allowPublicKeyRetrieval=true + SMUI_DB_USER=root + SMUI_DB_PASSWORD=password + +If you are using MySQL in a Docker Compose setup, then create the file `mysql/docker-entrypoint-initdb.d/db.sql`: + +:: + + CREATE DATABASE smui; + CREATE USER 'smui'@'%' IDENTIFIED BY 'smui'; + GRANT ALL PRIVILEGES ON smui.* TO 'smui'@'%'; + +Have the script run when MySQL starts via the volume mapping: `./mysql/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d`. + +Microsoft SQL Server Details +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The below settings assume you have a database named `smui` created on your localhost. + +:: + + SMUI_DB_JDBC_DRIVER=com.microsoft.sqlserver.jdbc.SQLServerDriver + SMUI_DB_URL=jdbc:sqlserver://localhost:1433;databaseName=smui + SMUI_DB_USER=sa + SMUI_DB_PASSWORD=Testing1122 + Advanced configuration ---------------------- diff --git a/docs/source/smui/using-smui.rst b/docs/source/smui/using-smui.rst index 7e2acc7..eed30ef 100644 --- a/docs/source/smui/using-smui.rst +++ b/docs/source/smui/using-smui.rst @@ -24,13 +24,14 @@ with the following database management systems: - PostgreSQL - SQLite - HSQLDB +- Microsoft SQL Server Where your database backend application runs, e.g. in a production environment, depends on your specific setup. Refer to the :ref:`basic configuration ` section on how to configure your database connection. -Once the database connection has been configured, SMUI will initialize the -database on first startup. +Once the database has been created, and the connection has been configured, SMUI will initialize the +database on startup. Managing rules --------------