From 34d71d537e80b9365dbf10d1f0a359f7c98d74f7 Mon Sep 17 00:00:00 2001 From: Jan Grewe Date: Thu, 19 Sep 2019 10:37:33 +0200 Subject: [PATCH] obscuring credentials and more docu --- docs/configuration.md | 13 +++++++++++++ dj_local_conf.json => template_dj_local_conf.json | 6 +++--- 2 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 docs/configuration.md rename dj_local_conf.json => template_dj_local_conf.json (55%) diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..4aa0f27 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,13 @@ +# Configuration + +## Database connection + +* Should work with mysql or mariaDB databases +* if you do not have access to a database server, go back to index.md to read how to install one locally + +To log into the database you need the `host`, the `database name`, the `user` name, and the `password`. +Note, the selected user needs at least read access on the selected database (True? maybe also write?). + +The root of the fishbook package contains a file called *template_dj_local_conf.json*. copy this file +to your project folder, i.e. the location from which you call your scripts, remove the `template_` prefix +and fill in `database.host`, `database.user`, `database.password`. diff --git a/dj_local_conf.json b/template_dj_local_conf.json similarity index 55% rename from dj_local_conf.json rename to template_dj_local_conf.json index 5153d58..e754e62 100644 --- a/dj_local_conf.json +++ b/template_dj_local_conf.json @@ -1,11 +1,11 @@ { - "database.host": "localhost", - "database.password": "datajoint", + "database.host": "yourhost", + "database.user": "yourdatabaseusername", + "database.password": "yourdatabaseuserpassword", "database.port": 3306, "loglevel": "DEBUG", "display.width": 14, "display.limit": 7, "safemode": false, - "database.user": "dj", "connection.init_function": null }