prehistoric-systems/FilterLists
1
0
Fork 0
mirror of https://github.com/collinbarrett/FilterLists.git synced 2026-03-11 09:04:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

add a note aboout Configuration to README/CONTRIBUTING

Browse source
This commit is contained in:
Collin M. Barrett 2019-07-06 20:56:59 -05:00
parent 59a4e067b3
commit 3c9767a24b
2 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored
View file

@ -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

4
.github/README.md vendored
View file

@ -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