diff --git a/.env b/.env.sample similarity index 100% rename from .env rename to .env.sample diff --git a/.github/workflows/lint_and_test.yml b/.github/workflows/lint_and_test.yml index 95b2b3f0..2492f664 100644 --- a/.github/workflows/lint_and_test.yml +++ b/.github/workflows/lint_and_test.yml @@ -11,10 +11,14 @@ jobs: run-tests: runs-on: ubuntu-latest env: + POSTGRES_DB: test_cu + POSTGRES_USER: admin POSTGRES_PASSWORD: supersecurepassword99 + RABBIT_VHOST: test_cu + RABBIT_USER: admin RABBIT_PASSWORD: supersecurepassword99 steps: - uses: actions/checkout@v3 - run: docker compose build - run: docker compose up -d - - run: docker compose exec -T app python runtests.py cantusdata.test.core \ No newline at end of file + - run: docker compose exec -T app python runtests.py cantusdata.test.core diff --git a/.gitignore b/.gitignore index 310c9ac0..9659cf4c 100644 --- a/.gitignore +++ b/.gitignore @@ -26,3 +26,5 @@ IntelliJ Idea files /public/media/* /public/htmlcov/* *.coverage + +.env diff --git a/README.md b/README.md index 3421a9e6..1cca3164 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ git submodule update --init We use [Docker Compose](https://docs.docker.com/compose/) to containerize each service and keep all our dependencies in order. Cantus Ultimus is compatible with Docker Compose > 2.8. ### The `.env` file -The build process relies on environment variables specified in the `.env` file, which is located at the root of the repository. +The build process relies on environment variables specified in an `.env` file located at the root of the repository. A sample of this file, `.env.sample`, is provided. -You must make two modifications to this file before the docker containers will build. Both `POSTGRES_PASSWORD` and `RABBIT_PASSWORD` should be uncommented and set with secure passwords. +Make a copy of `.env.sample` and name it `.env`. You must make two modifications to this file before the docker containers will build. Both `POSTGRES_PASSWORD` and `RABBIT_PASSWORD` should be uncommented and set with secure passwords. #### Handling `postgres` authentication issues