From 7dac5b2994b039f006b7e3e5d02138e40758cffc Mon Sep 17 00:00:00 2001 From: Yohan Boniface Date: Mon, 5 Jun 2023 16:59:49 +0200 Subject: [PATCH] Very minimal doc for Docker install --- docs/docker.md | 33 +++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 34 insertions(+) create mode 100644 docs/docker.md diff --git a/docs/docker.md b/docs/docker.md new file mode 100644 index 00000000..baceccb7 --- /dev/null +++ b/docs/docker.md @@ -0,0 +1,33 @@ +# Docker + +There is now an official [uMap](https://hub.docker.com/r/umap/umap) image. + +To run it with docker compose, use a `docker-compose.yml` like this: + +```yaml +version: '3' +services: + db: + image: postgis/postgis:14-3.3-alpine + environment: + - POSTGRES_HOST_AUTH_METHOD=trust + volumes: + - db:/var/lib/postgresql/data + + app: + image: umap/umap:x.x.x + ports: + - "8001:8000" + environment: + - DATABASE_URL=postgis://postgres@db/postgres + - SECRET_KEY=some-long-and-weirdly-unrandom-secret-key + - SITE_URL=https://umap.local/ + - UMAP_ALLOW_ANONYMOUS=True + - DEBUG=1 + volumes: + - data:/srv/umap/uploads + +volumes: + data: + db: +``` diff --git a/mkdocs.yml b/mkdocs.yml index 1293c4ae..c09cc09d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,5 +7,6 @@ nav: - how-tos: - Ubuntu from scratch: ubuntu.md - Customize your uMap style: custom.md + - Install with Docker: docker.md - Changelog: changelog.md theme: readthedocs