Backport master to develop

.gitignore

@@ -1,5 +1,6 @@
 # demo data
-projects/
+projects*/
+data/
 mergin_db
 
 logs
@@ -15,6 +16,8 @@ deps/
 venv/
 .vscode
 
+# production env
+.prod.env
 
 # generated documentation
 gen

LICENSES/CLA-signed-list.md

@@ -19,4 +19,4 @@ C/ My company has custom contribution contract with Lutra Consulting Ltd. or I a
 * lavor, 26th April 2023
 * luxusko, 25th August 2023
 * jozef-budac, 30th January 2024
-* fernandinand, 13th March 2025
+* fernandinand, 13th March 2025

README.md

@@ -74,7 +74,7 @@ Admin users can enter the admin interface available at `/admin` URL which provid
 
 ### Contributing
 
-Contributions are welcomed! You can set up development environment by following a guide in [development.md](./development.md). Before you create your first pull request, we kindly ask you to sign the CLA with your GitHub user name and date [here](LICENSES/CLA-signed-list.md).
+Contributions are welcomed! You can set up development environment by following a guide in [development.md](./deployment/community/development.md). Before you create your first pull request, we kindly ask you to sign the CLA with your GitHub user name and date [here](LICENSES/CLA-signed-list.md).
 
 ## Documentation
 
@@ -86,14 +86,14 @@ If you'd like to contribute and improve the documentation, visit https://github.
 If you need support, a custom deployment, extending the service capabilities and new features do not hesitate to contact us on info@lutraconsulting.co.uk
 <br><br>
 
-<div><a href="https://merginmaps.com/community/join"><img align="left" width="45" height="45" src="https://raw.githubusercontent.com/MerginMaps/docs/main/src/.vuepress/public/slack.svg">Join our community chat</a><br/>and ask questions!</div>
+<div><img align="left" width="45" height="45" src="https://raw.githubusercontent.com/MerginMaps/docs/main/src/public/slack.svg"><a href="https://merginmaps.com/community/join">Join our community chat</a><br/>and ask questions!</div>
 <br>
 
 ## Developers
 
 Contributions are welcome!
 
-More information for developers can be found in the dedicated [development](development.md) page.
+More information for developers can be found in the dedicated [development](./deployment/community/development.md) page.
 
 Client side modules:
 - [Python](https://github.com/MerginMaps/python-api-client) client library + CLI

deployment/common/entrypoint.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Copyright (C) Lutra Consulting Limited
+#
+# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-MerginMaps-Commercial
+
+# make sure all files created by gunicorn (mergin server) have proper permissions
+umask 0027
+
+# Settings passed to gunicorn have the following order of precedence
+# (tested using --workers):
+#
+# 1. Command-line (highest)
+# 2. Environment variable
+# 3. File referenced by --config (lowest)
+#
+# We store a base config in config.py and override things as needed
+# using the environment variable GUNICORN_CMD_ARGS.
+
+exec sh -c "$@"

deployment/common/set_permissions.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+# Changes permissions recursively at folder and files level from a provided path
+# ARGS:
+# 1 - The target path
+
+
+set -e
+
+export MERGIN_DIR=$1
+sudo mkdir -p $MERGIN_DIR
+sudo find $MERGIN_DIR -type f -exec sudo chmod 640 {} \;
+sudo find $MERGIN_DIR -type d -exec sudo chmod 750 {} \;
+sudo find $MERGIN_DIR -type d -exec sudo chmod g+s {} \;
+sudo chown -R 901:999 $MERGIN_DIR

.prod.env → deployment/community/.env.template

@@ -29,12 +29,11 @@ TEMP_DIR=/data/tmp
 
 #DB_APPLICATION_NAME=mergin
 
-#DB_DATABASE=postgres
+#DB_DATABASE=mergin
 
-#DB_HOST=localhost
 DB_HOST=db
 
-#DB_PASSWORD=postgres
+DB_PASSWORD=postgres
 
 #DB_POOL_MAX_OVERFLOW=10  # max_overflow set to SQLAlchemy default https://docs.sqlalchemy.org/en/14/core/engines.html
 

deployment/community/README.md

@@ -0,0 +1,16 @@
+# Mergin Maps Community Edition Deployment
+Suitable for Ubuntu servers, one node deployment using docker compose and system nginx as a reverse proxy.
+
+> [!IMPORTANT] 
+> You need to have Docker installed on your system.
+> If you don't have, follow the official [documentation](https://docs.docker.com/engine/install/)
+
+Then modify [docker-compose file](docker-compose.yml) and create environment file `.prod.env` from `.env.template`. Details about configuration can be find in [docs](https://merginmaps.com/docs/server/install/).
+
+```shell
+cp .env.template .prod.env
+```
+
+Next step is to create data directory for mergin maps `projects` with proper permissions. Should you prefer a different location, please do search and replace it in config files (`.prod.env`, `docker-compose.yml`). Make sure your volume is large enough since mergin maps keeps all projects files, their history and also needs some space for temporary processing.
+
+For more details about deployment please check [docs](https://merginmaps.com/docs/server/install/#deployment).

docker-compose.dev.yml → deployment/community/docker-compose.dev.yml

@@ -1,34 +1,34 @@
-version: "3.7"
+
 
 services:
-  server-gunicorn:
-    image: server-gunicorn
+  server:
+    image: server
     build:
-      context: ./server
+      context: ../../server
       dockerfile: Dockerfile
     env_file:
       - .prod.env
       - .dev.env
   celery-beat:
     image: celery-beat
     build:
-      context: ./server
+      context: ../../server
       dockerfile: Dockerfile
     env_file:
       - .prod.env
       - .dev.env
   celery-worker:
     image: celery-worker
     build:
-      context: ./server
+      context: ../../server
       dockerfile: Dockerfile
     env_file:
       - .prod.env
       - .dev.env
   web:
     image: merginmaps-frontend
     build:
-      context: ./web-app
+      context: ../../web-app
       dockerfile: Dockerfile
   maildev:
     image: maildev/maildev

docker-compose.yml → deployment/community/docker-compose.yml

@@ -1,6 +1,7 @@
-version: "3.7"
+
 networks:
   merginmaps:
+    name: mergin
 
 services:
   db:
@@ -10,8 +11,9 @@ services:
     networks:
       - merginmaps
     environment:
+      - POSTGRES_DB=mergin
       - POSTGRES_USER=postgres
-      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_PASSWORD=postgres # !TODO Change this and also change .prod.env $DB_PASSWORD accordingly
     volumes:
       - ./mergin_db:/var/lib/postgresql/data
   redis:
@@ -20,14 +22,14 @@ services:
     restart: always
     networks:
       - merginmaps
-  server-gunicorn:
+  server:
     image: lutraconsulting/merginmaps-backend:2025.2.2
     container_name: merginmaps-server
     restart: always
     user: 901:999
     volumes:
       - ./projects:/data
-      - ./server/entrypoint.sh:/app/entrypoint.sh
+      - ../common/entrypoint.sh:/app/entrypoint.sh
     env_file:
       - .prod.env
     depends_on:
@@ -46,10 +48,10 @@ services:
       - GEVENT_WORKER=0
       - NO_MONKEY_PATCH=1
     volumes:
-      - ./server/entrypoint.sh:/app/entrypoint.sh
+      - ../common/entrypoint.sh:/app/entrypoint.sh
     depends_on:
       - redis
-      - server-gunicorn
+      - server
     command: [ "celery -A application.celery beat --loglevel=info" ]
     networks:
       - merginmaps
@@ -65,10 +67,10 @@ services:
       - NO_MONKEY_PATCH=1
     volumes:
       - ./projects:/data
-      - ./server/entrypoint.sh:/app/entrypoint.sh
+      - ../common/entrypoint.sh:/app/entrypoint.sh
     depends_on:
       - redis
-      - server-gunicorn
+      - server
       - celery-beat
     command: [ "celery -A application.celery worker --loglevel=info" ]
     networks:
@@ -78,7 +80,7 @@ services:
     container_name: merginmaps-web
     restart: always
     depends_on:
-      - server-gunicorn
+      - server
     user: 101:999
     links:
       - db
@@ -93,8 +95,7 @@ services:
     ports:
       - "8080:8080"
     volumes:
-      - ./projects:/data  # map data dir to host
-      - ./nginx.conf:/etc/nginx/conf.d/default.conf
-      - ./logs:/var/log/nginx/
+      - ./projects:/data  # mergin maps projects data dir to host
+      - ../common/nginx.conf:/etc/nginx/conf.d/default.conf
     networks:
       - merginmaps