From 4afa513dced3b9ef024bc366b4fc884802730d50 Mon Sep 17 00:00:00 2001 From: Toby Jaffey Date: Mon, 12 Dec 2022 10:26:38 +0000 Subject: Add docker-compose support, so a working development server with HTTPS can be started with: docker-compose build && docker-compose up --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README.md') 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. See the administrator manual on how to proceed from here. +# Testing via Docker + +A `docker-compose` file is provided for development and testing. To start snac with an nginx HTTPS frontend, run: + + docker-compose build && docker-compose up + +This will: + +- Start snac, storing data in `data/` +- Configure snac to listen on port 8001 with a server name of `localhost` (see `examples/docker-entrypoint.sh`) +- Create a new user `testuser` and print the user's generated password on the console (see `examples/docker-entrypoint.sh`) +- Start nginx to handle HTTPS, using the certificate pair from `nginx-alpine-ssl/nginx-selfsigned.*` (see `examples/nginx-alpine-ssl/entrypoint.sh`) + # License See the LICENSE file for details. -- cgit v1.2.3