diff options
| author |  thursday <xthursdayx@mailbox.org> | 2021-07-12 22:12:27 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2021-07-12 22:12:27 -0400 |
| commit | 8bbfb28e7aff6d8ba758242423293f492e223260 (patch) | |
| tree | 64c3eb6c2fa6e03d79c69063972d93ec82c9fee0 /docker | |
| parent | Update README.md (diff) | |
| download | ferdium-server-8bbfb28e7aff6d8ba758242423293f492e223260.tar.gz ferdium-server-8bbfb28e7aff6d8ba758242423293f492e223260.tar.zst ferdium-server-8bbfb28e7aff6d8ba758242423293f492e223260.zip | |
Update README.md
Updated default database names throughout readme.
Diffstat (limited to 'docker')
| -rw-r--r-- | docker/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
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: | |||
| 69 | docker-compose up | 69 | docker-compose up |
| 70 | The server will be launched at [http://localhost:3333/](http://localhost:3333/) address. | 70 | The server will be launched at [http://localhost:3333/](http://localhost:3333/) address. |
| 71 | 71 | ||
| 72 | **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. | 72 | **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. |
| 73 | 73 | ||
| 74 | ## Configuration | 74 | ## Configuration |
| 75 | 75 | ||
| @@ -88,7 +88,7 @@ Container images are configured using parameters passed at runtime (such as thos | |||
| 88 | | `-e DB_PORT=<yourdbport>` | for specifying the database port, default is 3306 | | 88 | | `-e DB_PORT=<yourdbport>` | for specifying the database port, default is 3306 | |
| 89 | | `-e DB_USER=<yourdbuser>` | for specifying the database user, default is root | | 89 | | `-e DB_USER=<yourdbuser>` | for specifying the database user, default is root | |
| 90 | | `-e DB_PASSWORD=<yourdbpass>` | for specifying the database password, default is password | | 90 | | `-e DB_PASSWORD=<yourdbpass>` | for specifying the database password, default is password | |
| 91 | | `-e DB_DATABASE=<databasename>` | for specifying the database name to be used, default is database | | 91 | | `-e DB_DATABASE=<databasename>` | for specifying the database name to be used, default is ferdi | |
| 92 | | `-e DB_SSL=false` | true only if your database is postgres and it is hosted online, on platforms like GCP, AWS, etc | | 92 | | `-e DB_SSL=false` | true only if your database is postgres and it is hosted online, on platforms like GCP, AWS, etc | |
| 93 | | `-e MAIL_CONNECTION=<mailsender>` | for specifying the mail sender to be used, default is smtp | | 93 | | `-e MAIL_CONNECTION=<mailsender>` | for specifying the mail sender to be used, default is smtp | |
| 94 | | `-e SMPT_HOST=<smtpmailserver>` | for specifying the mail host to be used, default is 127.0.0.1 | | 94 | | `-e SMPT_HOST=<smtpmailserver>` | 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 | |||
| 101 | | `-e IS_DASHBOARD_ENABLED=true` | for specifying whether to enable the Ferdi-server dashboard, default is true | | 101 | | `-e IS_DASHBOARD_ENABLED=true` | for specifying whether to enable the Ferdi-server dashboard, default is true | |
| 102 | | `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is true | | 102 | | `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is true | |
| 103 | | `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is true | | 103 | | `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is true | |
| 104 | | `-e DATA_DIR=data` | for specifying the SQLite database folder, default is database | | 104 | | `-e DATA_DIR=data` | for specifying the SQLite database folder, default is data | |
| 105 | | `-v <path to data>:/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 | | 105 | | `-v <path to data>:/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 | |
| 106 | | `-v <path to database>:/app/data` | this will store Ferdi-server's database on the docker host for persistence | | 106 | | `-v <path to database>:/app/data` | this will store Ferdi-server's database on the docker host for persistence | |
| 107 | | `-v <path to recipes>:/app/recipes` | this will store Ferdi-server's recipes on the docker host for persistence | | 107 | | `-v <path to recipes>:/app/recipes` | this will store Ferdi-server's recipes on the docker host for persistence | |