From 034aee1443dd30d7d36559eff8a8c9a5d9b6da00 Mon Sep 17 00:00:00 2001 From: Hironsan Date: Thu, 18 Nov 2021 16:01:25 +0900 Subject: [PATCH] Update README.md --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9530976b..ee6344a6 100644 --- a/README.md +++ b/README.md @@ -150,13 +150,19 @@ _Note for Windows developers:_ Be sure to configure git to correctly handle line git clone https://github.com/doccano/doccano.git --config core.autocrlf=input ``` -Set the superuser account credentials in the `./config/env.example` file: +Then, create an `.env` file with variables in the following format(see [./config/.env.example](https://github.com/doccano/doccano/blob/master/config/.env.example)): ```plain +# platform settings ADMIN_USERNAME=admin ADMIN_PASSWORD=password ADMIN_EMAIL=admin@example.com +# rabbit mq settings +RABBITMQ_DEFAULT_USER=doccano +RABBITMQ_DEFAULT_PASS=doccano + +# database settings POSTGRES_USER=doccano POSTGRES_PASSWORD=doccano POSTGRES_DB=doccano @@ -167,7 +173,7 @@ POSTGRES_DB=doccano After running the following command, access . ```bash -docker-compose -f docker-compose.prod.yml --env-file ./config/env.example up +docker-compose -f docker-compose.prod.yml --env-file ./config/.env.example up ``` #### Development @@ -175,7 +181,7 @@ docker-compose -f docker-compose.prod.yml --env-file ./config/env.example up After running the following command, access . If you want to use the admin site, please access . ```bash -docker-compose -f docker-compose.dev.yml --env-file ./config/env.example up +docker-compose -f docker-compose.dev.yml --env-file ./config/.env.example up ``` You can run the the test codes for the backend with the following command: