Browse Source

Update README.md

pull/1566/head
Hironsan 3 years ago
parent
commit
034aee1443
1 changed files with 9 additions and 3 deletions
  1. 12
      README.md

12
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 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 ```plain
# platform settings
ADMIN_USERNAME=admin ADMIN_USERNAME=admin
ADMIN_PASSWORD=password ADMIN_PASSWORD=password
ADMIN_EMAIL=admin@example.com ADMIN_EMAIL=admin@example.com
# rabbit mq settings
RABBITMQ_DEFAULT_USER=doccano
RABBITMQ_DEFAULT_PASS=doccano
# database settings
POSTGRES_USER=doccano POSTGRES_USER=doccano
POSTGRES_PASSWORD=doccano POSTGRES_PASSWORD=doccano
POSTGRES_DB=doccano POSTGRES_DB=doccano
@ -167,7 +173,7 @@ POSTGRES_DB=doccano
After running the following command, access <http://0.0.0.0/>. After running the following command, access <http://0.0.0.0/>.
```bash ```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 #### Development
@ -175,7 +181,7 @@ docker-compose -f docker-compose.prod.yml --env-file ./config/env.example up
After running the following command, access <http://127.0.0.1:3000/>. If you want to use the admin site, please access <http://127.0.0.1:8000/admin/>. After running the following command, access <http://127.0.0.1:3000/>. If you want to use the admin site, please access <http://127.0.0.1:8000/admin/>.
```bash ```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: You can run the the test codes for the backend with the following command:

Loading…
Cancel
Save