summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Toby Jaffey2022-12-12 10:26:38 +0000
committerGravatar Toby Jaffey2022-12-12 10:26:38 +0000
commit4afa513dced3b9ef024bc366b4fc884802730d50 (patch)
tree51098e478054a66439e98dfab89cbbedf5d9f5c0 /README.md
parentBackport from xs. (diff)
downloadsnac2-4afa513dced3b9ef024bc366b4fc884802730d50.tar.gz
snac2-4afa513dced3b9ef024bc366b4fc884802730d50.tar.xz
snac2-4afa513dced3b9ef024bc366b4fc884802730d50.zip
Add docker-compose support, so a working development server with HTTPS can be started with:
docker-compose build && docker-compose up
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1b7dc50..7b63d7b 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,19 @@ Run `make` and then `make install` as root.
43 43
44See the administrator manual on how to proceed from here. 44See the administrator manual on how to proceed from here.
45 45
46# Testing via Docker
47
48A `docker-compose` file is provided for development and testing. To start snac with an nginx HTTPS frontend, run:
49
50 docker-compose build && docker-compose up
51
52This will:
53
54- Start snac, storing data in `data/`
55- Configure snac to listen on port 8001 with a server name of `localhost` (see `examples/docker-entrypoint.sh`)
56- Create a new user `testuser` and print the user's generated password on the console (see `examples/docker-entrypoint.sh`)
57- Start nginx to handle HTTPS, using the certificate pair from `nginx-alpine-ssl/nginx-selfsigned.*` (see `examples/nginx-alpine-ssl/entrypoint.sh`)
58
46# License 59# License
47 60
48See the LICENSE file for details. 61See the LICENSE file for details.