From 8bbfb28e7aff6d8ba758242423293f492e223260 Mon Sep 17 00:00:00 2001 From: thursday Date: Mon, 12 Jul 2021 22:12:27 -0400 Subject: Update README.md Updated default database names throughout readme. --- docker/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docker') diff --git a/docker/README.md b/docker/README.md index d32f488..144a766 100644 --- a/docker/README.md +++ b/docker/README.md @@ -69,7 +69,7 @@ To create the docker container with the proper parameters: docker-compose up The server will be launched at [http://localhost:3333/](http://localhost:3333/) address. -**Existing users please note:** The latest updates to Ferdi-server and the Ferdi-server Docker image introduce changes to the default sqlite database name and location, please see the comments in the sample [./docker/docker-compose.yml](https://github.com/getferdi/server/tree/master/docker/docker-compose.yml) in order to continue using your existing database. +**Existing users please note:** The latest updates to Ferdi-server and the Ferdi-server Docker image introduce changes to the default SQLite database name and location, please see the comments in the sample [./docker/docker-compose.yml](https://github.com/getferdi/server/tree/master/docker/docker-compose.yml) in order to continue using your existing database. ## Configuration @@ -88,7 +88,7 @@ Container images are configured using parameters passed at runtime (such as thos | `-e DB_PORT=` | for specifying the database port, default is 3306 | | `-e DB_USER=` | for specifying the database user, default is root | | `-e DB_PASSWORD=` | for specifying the database password, default is password | -| `-e DB_DATABASE=` | for specifying the database name to be used, default is database | +| `-e DB_DATABASE=` | for specifying the database name to be used, default is ferdi | | `-e DB_SSL=false` | true only if your database is postgres and it is hosted online, on platforms like GCP, AWS, etc | | `-e MAIL_CONNECTION=` | for specifying the mail sender to be used, default is smtp | | `-e SMPT_HOST=` | for specifying the mail host to be used, default is 127.0.0.1 | @@ -101,7 +101,7 @@ Container images are configured using parameters passed at runtime (such as thos | `-e IS_DASHBOARD_ENABLED=true` | for specifying whether to enable the Ferdi-server dashboard, default is true | | `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is true | | `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is true | -| `-e DATA_DIR=data` | for specifying the SQLite database folder, default is database | +| `-e DATA_DIR=data` | for specifying the SQLite database folder, default is data | | `-v :/config` | this will store persistent configuration data on the docker host. See the [Docker docs](https://docs.docker.com/storage/volumes/) for more information on the use of container volumes | | `-v :/app/data` | this will store Ferdi-server's database on the docker host for persistence | | `-v :/app/recipes` | this will store Ferdi-server's recipes on the docker host for persistence | -- cgit v1.2.3-54-g00ecf