From 7a0d36fdb38fc364035cb0846f94885ce5a56cdb Mon Sep 17 00:00:00 2001 From: David Larlet Date: Fri, 2 Aug 2024 11:36:16 -0400 Subject: [PATCH 1/2] chore: use latest Docker keyword for docker-compose --- Makefile | 4 ++-- docker-compose.yml | 18 +++++++++++++----- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index c84fc1eab..d0b4ec82b 100644 --- a/Makefile +++ b/Makefile @@ -43,8 +43,8 @@ minor: ## Bump the current version to a new minor one docker: ## Create a new Docker image and publish it $(eval VERSION=$(shell hatch version)) @echo "Version to build: ${VERSION}" - docker build -t umap/umap:${VERSION} . - docker push umap/umap:${VERSION} + docker build -t umap/umap:${VERSION} -t umap/umap:latest . + docker push --all-tags umap/umap:${VERSION} .PHONY: build build: ## Build the Python package before release diff --git a/docker-compose.yml b/docker-compose.yml index e77ad38d0..24cb0bc2f 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -6,6 +6,7 @@ services: healthcheck: test: ["CMD-SHELL", "pg_isready -U postgres"] interval: 2s + # check https://hub.docker.com/r/postgis/postgis to see available versions image: postgis/postgis:14-3.3-alpine environment: - POSTGRES_HOST_AUTH_METHOD=trust @@ -16,18 +17,25 @@ services: depends_on: db: condition: service_healthy - image: umap/umap:2.0.2 + image: umap/umap:latest ports: - - "${PORT-8000}:8000" + # modify the external port (8001, on the left) if desired, but make sure it matches SITE_URL, below + - "8001:8000" environment: - DATABASE_URL=postgis://postgres@db/postgres - SECRET_KEY=some-long-and-weirdly-unrandom-secret-key - - SITE_URL=https://umap.local/ + - SITE_URL=https://localhost:8001/ - UMAP_ALLOW_ANONYMOUS=True - DEBUG=1 + - STATIC_ROOT=/srv/umap/static + - MEDIA_ROOT=/srv/umap/uploads volumes: - - data:/srv/umap/uploads + - umap_userdata:/srv/umap/uploads + # FIX the path on the left, below, to your location + # OPTIONAL, you can comment the line below out for default + # values to apply + - /home/ubuntu/umap.conf:/etc/umap/umap.conf volumes: - data: + umap_userdata: db: From 836d84a53202ffb899f8757bfb0c05d5d8187767 Mon Sep 17 00:00:00 2001 From: David Larlet Date: Fri, 2 Aug 2024 11:36:47 -0400 Subject: [PATCH 2/2] chore: direct reference docker-compose file in docs --- docs/deploy/docker.md | 35 +---------------------------------- mkdocs.yml | 1 + 2 files changed, 2 insertions(+), 34 deletions(-) diff --git a/docs/deploy/docker.md b/docs/deploy/docker.md index e0291e204..5841ec6ad 100644 --- a/docs/deploy/docker.md +++ b/docs/deploy/docker.md @@ -3,40 +3,7 @@ An official uMap docker image is [available on the docker hub](https://hub.docker.com/r/umap/umap). But, if you prefer to run it with docker compose, here is the configuration file: ```yaml title="docker-compose.yml" -version: '3' -services: - db: - # check https://hub.docker.com/r/postgis/postgis to see available versions - image: postgis/postgis:14-3.4-alpine - environment: - - POSTGRES_HOST_AUTH_METHOD=trust - volumes: - - umap_db:/var/lib/postgresql/data - - app: - # Check https://hub.docker.com/r/umap/umap/tags to find the latest version - image: umap/umap:2.0.2 - ports: - # modify the external port (8001, on the left) if desired, but make sure it matches SITE_URL, below - - "8001:8000" - environment: - - DATABASE_URL=postgis://postgres@db/postgres - - SITE_URL=https://localhost:8001/ - - STATIC_ROOT=/srv/umap/static - - MEDIA_ROOT=/srv/umap/uploads - volumes: - - umap_userdata:/srv/umap/uploads - # FIX the path on the left, below, to your location - # OPTIONAL, you can comment the line below out for default - # values to apply - - /home/ubuntu/umap.conf:/etc/umap/umap.conf - restart: always - depends_on: - - db - -volumes: - umap_userdata: - umap_db: +--8<-- "./docker-compose.yml" ``` Note that you’ll have to set a [`SECRET_KEY`](https://docs.djangoproject.com/en/5.0/ref/settings/#secret-key) environment variable that must be secret and unique. One way to generate it is through the `secrets` module from Python: diff --git a/mkdocs.yml b/mkdocs.yml index 032e04495..6008dc933 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,3 +59,4 @@ markdown_extensions: - pymdownx.tabbed: alternate_style: true combine_header_slug: true + - pymdownx.snippets