diff options
| author |  grunfink | 2022-12-13 08:15:52 +0000 |
|---|---|---|
| committer | grunfink | 2022-12-13 08:15:52 +0000 |
| commit | 1eb5c7a6e2f5436c8f0be77acc06672a5f24562a (patch) | |
| tree | 51098e478054a66439e98dfab89cbbedf5d9f5c0 /README.md | |
| parent | Backport from xs. (diff) | |
| parent | Add docker-compose support, so a working development server with HTTPS can be... (diff) | |
| download | snac2-1eb5c7a6e2f5436c8f0be77acc06672a5f24562a.tar.gz snac2-1eb5c7a6e2f5436c8f0be77acc06672a5f24562a.tar.xz snac2-1eb5c7a6e2f5436c8f0be77acc06672a5f24562a.zip | |
Merge pull request 'Add docker-compose support' (#22) from tobyjaffey/snac2:docker into master
Reviewed-on: https://codeberg.org/grunfink/snac2/pulls/22
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
| @@ -43,6 +43,19 @@ Run `make` and then `make install` as root. | |||
| 43 | 43 | ||
| 44 | See the administrator manual on how to proceed from here. | 44 | See the administrator manual on how to proceed from here. |
| 45 | 45 | ||
| 46 | # Testing via Docker | ||
| 47 | |||
| 48 | A `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 | |||
| 52 | This 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 | ||
| 48 | See the LICENSE file for details. | 61 | See the LICENSE file for details. |