Merge branch 'main' of git.sunet.se:soc_collector into fastapi_pytest

1 files changed, 12 insertions, 1 deletions

diff --git a/README.md b/README.md
index 1537048..1e4ecbb 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,7 @@ Clone the repository.
 
 Install dependencies (Debian).
 
-    sudo apt install docker.io docker-compose
+    sudo apt install docker.io docker-compose jq curl apache2-utils
 
 Start the collector and JWT server, and generate certificates for JWT signing:
 
@@ -81,6 +81,17 @@ We can also limit the number of results and skip N results forward with the para
 
     curl -s -H "Authorization: Bearer $JWT" 'http://localhost:80/sc/v0/get?limit=5&skip=2' | json_pp -json_opt utf8,pretty
 
+## Development
+
+There are two docker-compose files used for development:
+
+- `docker/docker-compose-dev.yaml` for the collector, and
+- `auth-server-poc/docker-compose.yml` for the JWT server.
+
+To apply changes, build with `docker-compose build -f docker/docker-compose-dev.yaml` or `docker-compose -f auth-server-poc/docker-compose.yml` (depending on what has changed) and then restart the containers with `./quickstart.sh`.
+
+If you want to save build time you can also pass a service name to `docker-compose build`, i.e. `docker-compose build -f docker/docker-compose-dev.yaml collector`.
+
 ## JWT mechanics (work in progress)
 
 2021-11-24: Currently no checks except that the JWT is valid are performed when