From 53d17214e4e9e1e630d625a51d05484c3770fad1 Mon Sep 17 00:00:00 2001 From: xengineering Date: Fri, 11 Nov 2022 16:40:32 +0100 Subject: Remove user setup from initial migration The initial migration used to add the Ceres database and user. This works well for the production use case but is not that suitable for the development / debugging use case where the default user of the developer should be used. With this commit the generic user setup is explained in the README which can be applied to the developers Linux user aswell as a system user for the production use case. --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 50 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fec43bf..9d3812e 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,59 @@ # Ceres - Recipe server for your favorite dishes -With Ceres you can run a little recipe server in your home network. Have a look -at the [project page][1] for more details. +With Ceres you can run a recipe server in your home network. Have a look at the +[project page][1] for more details. All notable changes are documented in the [changelog][2]. +## Setup Ceres database + +Ceres supports only the [MariaDB][3] SQL implementation which is available on a +lot of Linux distributions. + +Database creation should be easy so please install MariaDB on your system and +then just run the first migration script with root user rights like this: + +``` + mariadb -u root < sql/0001_migration.sql +``` + +After database creation you have to also grant access to the database for a +Linux user. See the next section for details. + + +## Grant access to Ceres database for a Linux user + +If you want to use Ceres for production it is recommended to add a Linux user +for this purpose like this: + +``` + useradd ceres +``` + +For development you can just go on with your default Linux username. First +start an interactive MariaDB shell like this: + +``` + mariadb -u root +``` + +And then add a corresponding MariaDB user for the selected Linux user and set +corresponding access rights (substitute with the selected username): + +``` + CREATE USER IF NOT EXISTS ''@'localhost' IDENTIFIED VIA unix_socket; + GRANT ALL PRIVILEGES on ceres.* to ''@'localhost'; + FLUSH PRIVILEGES; +``` + +The `unix_socket` authentication method ensures that the corresponding user +does not need to provide a password. + +Finally you can quit the MariaDB shell with CTRL + d. + + [1]: https://xengineering.eu/git/ceres [2]: ./CHANGELOG.md +[3]: https://mariadb.com/ -- cgit v1.2.3-70-g09d2