From 3c9767a24bc5214a9328600d69c4205ff078e70c Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Sat, 6 Jul 2019 20:56:59 -0500 Subject: [PATCH] add a note aboout Configuration to README/CONTRIBUTING --- .github/CONTRIBUTING.md | 4 ++++ .github/README.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8ca5b25cb..6e7d244a5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,6 +24,10 @@ We have containerized FilterLists to make it as easy as possible for contributer 4. Execute `docker-compose up`. (Optionally, include the `-d` flag to launch in [detached mode](https://docs.docker.com/compose/reference/up/).) 5. After a minute or so, visit the locally running version of FilterLists in a web browser at `http://localhost/`. +### Configuration + +The `appsettings*.json` files are only used when debugging in Visual Studio outside of Docker ([they are not copied into the built runtime images](https://github.com/collinbarrett/FilterLists/blob/59a4e067b35110ebda5d5cf1e3ef96cab2fcbfe5/.dockerignore#L28)). When running any of the projects in containers via Docker/Docker Compose, the configuration is passed in as environment variables configured in the [`.env` file](https://github.com/collinbarrett/FilterLists/blob/master/.env) and the `docker-compose*.yml` files. + ### Testing changes to the data (.json files) #### Automated diff --git a/.github/README.md b/.github/README.md index 8fc87edb9..0ab90c277 100644 --- a/.github/README.md +++ b/.github/README.md @@ -64,6 +64,10 @@ We have containerized FilterLists to make it as easy as possible for contributer 4. Execute `docker-compose up`. (Optionally, include the `-d` flag to launch in [detached mode](https://docs.docker.com/compose/reference/up/).) 5. After a minute or so, visit the locally running version of FilterLists in a web browser at `http://localhost/`. +### Configuration + +The `appsettings*.json` files are only used when debugging in Visual Studio outside of Docker ([they are not copied into the built runtime images](https://github.com/collinbarrett/FilterLists/blob/59a4e067b35110ebda5d5cf1e3ef96cab2fcbfe5/.dockerignore#L28)). When running any of the projects in containers via Docker/Docker Compose, the configuration is passed in as environment variables configured in the [`.env` file](https://github.com/collinbarrett/FilterLists/blob/master/.env) and the `docker-compose*.yml` files. + ### Testing changes to the data (.json files) #### Automated