Merge branch 'main' into iss_576-ee-webmaps

MarcelGeo · MarcelGeo · commit 16d3039e35ca · 2025-04-23T15:44:36.000+02:00
diff --git a/scripts/wordlist.txt b/scripts/wordlist.txt
@@ -121,6 +121,7 @@ QField
 QFieldCloud
 QFieldSync
 QGIS
+qgis
 QString
 QgsField
 Qt
@@ -194,6 +195,7 @@ frontend
 gdal
 geo
 geoid
+github
 gpkg
 hotline
 html
@@ -283,6 +285,7 @@ xcf
 xyz
 yml
 webmaps
+WebMaps
 webp
 workspaces
 www
diff --git a/src/server/environment/index.md b/src/server/environment/index.md
@@ -1,6 +1,6 @@
 # Configure environment
 
-There are several application settings which can be changed via <GitHubRepo desc="config variables" id="MerginMaps/server/blob/master/.prod.env" />. Some of them have defaults and some of them need to be modified, particularly those with required placeholders (marked with ⭐️ below).
+There are several application settings which can be changed via <GitHubRepo desc="enterprise edition config variables" id="MerginMaps/server/blob/master/deployment/enterprise/.env.template" /> or <GitHubRepo desc="community edition config variables" id="MerginMaps/server/blob/master/deployment/enterprise/.env.template" />. Some of them have defaults and some of them need to be modified, particularly those with required placeholders (marked with ⭐️ below).
 ​
 #### Server basics
 Variables marked with star ⭐️ need to be modified for production use.
@@ -116,15 +116,21 @@ Other settings related to data management.
 | `DELETED_PROJECT_EXPIRATION` | integer  | `7`                                   | Lifetime in days for deleted projects. Expired projects are removed permanently without possibility to restore afterwards.                                                                                |
 | `PROJECT_ACCESS_REQUEST`     | integer  | `604800`                              | Lifetime of active project access request in seconds.                                                                                                                                                     |
 | `TEMP_EXPIRATION`            | integer  | `7`                                   | Time in days after files in a temporary folder are permanently deleted.                                                                                                                                   |
-​
+
 
 #### Celery asynchronous tasks
 Mergin Maps is using Celery and Redis to perform asynchronous tasks or doing regular jobs.
 
-| Variable name                 | Type    | Default                           | Description |
-|-------------------------------|---------|-----------------------------------|-------------|
-| `BROKER_URL` ⭐️               | string  | `redis://merginmaps-redis:6379/0` | Connection details to celery message broker. If non-default, it should match definition in `docker-compose` file.  |
-| `CELERY_RESULT_BACKEND`       | string  | `redis://merginmaps-redis:6379/0` | Connection details to celery result back-end broker. If non-default, it should match definition in `docker-compose` file.  |
-| `CELERYD_CONCURRENCY`         | integer | All CPU                           | Number of child processes. As rule of thumb do not use all available CPUs. |
-| `CELERYD_PREFETCH_MULTIPLIER` | integer | 4                                 | The number of messages to prefetch at a time multiplied by the number of concurrent processes. Default is `4`. If you want to disable this feature set it to `1`. |
-| `CELERY_ACKS_LATE`            | boolean | False                             | If `True`, means tasks will be transmitted as execute, AFTER they are finished, not 'right before'. |
+| Variable name         | Type | Default                         | Description |
+|-----------------------|------|---------------------------------|-------------|
+|`BROKER_URL`           |string|`redis://merginmaps-redis:6379/0`| Connection details to celery message broker. If non-default, it should match definition in `docker-compose` file.  |
+|`CELERY_RESULT_BACKEND`|string|`redis://merginmaps-redis:6379/0`| Connection details to celery result back-end broker. If non-default, it should match definition in `docker-compose` file.  |
+
+#### WebMaps 
+<ServerType type="EE" />
+
+| Variable name            | Type     | Default                       | Description                    |
+|--------------------------|----------|-------------------------------|--------------------------------|
+| `MAPS_ENABLED`           | boolean  | `true`                       | Flag to enable webmaps         |
+| `VECTOR_TILES_URL`       | string   | `https://tiles-ee.merginmaps.com/data/default/{z}/{x}/{y}.pbf`                            | URL to vector tiles which are used as basemap layer in webmaps |
+| `VECTOR_TILES_STYLE_URL` | string   | `https://tiles-ee.merginmaps.com/styles/default.json`                            | URL to vector tiles style |
diff --git a/src/server/install/index.md b/src/server/install/index.md
@@ -26,22 +26,48 @@ Afterwards, you can follow [this guide](./ee/) to retrieve your <EnterprisePlatf
 
 ::: warning Enable <MainPlatformName /> Telemetry
 Make sure you follow deployment guidelines to <b>ensure any firewalls in your infrastructure are configured to allow the [`call-home`](../administer/#telemetry-service) functionality to send usage data</b>.
+:::
 
 ## Deployment
 
 Follow these steps to run a local <MainPlatformName /> instance.
 
+Clone the <MainPlatformName /> github repository locally or download <GitHubRepo id="MerginMaps/server/blob/master/deployment/" desc="deployment folder" />.
+```bash
+$ git clone git@github.com:MerginMaps/server.git
+```
+
+Locate yourself on the proper <MainPlatformName /> edition.
+```shell
+# For community edition
+cd deployment/community
+
+# For enterprise edition
+cd deployment/enterprise
+```
+
 ### Start docker containers
 
-Provided that `docker` and `docker-compose` are installed on your host, running <MainPlatformName /> stack should be as simple as running `docker-compose`. However, before doing that you would need to [configure](../environment/) your server setup via environment variables in <GitHubRepo desc=".prod.env" id="MerginMaps/server/blob/master/.prod.env" /> file. 
+Provided that `docker` and `docker-compose` are installed on your host, running <MainPlatformName /> stack should be as simple as running `docker-compose`. However, before doing that you would need to [configure](../environment/) your server setup via environment variables in `.prod.env` file.
+If you have not created this file yet, please do so from the provided `.env.template` file provided.
+
+```shell
+cp .env.template .prod.env
+```
 
 Once configured, you can run:
 ```shell
-$ mkdir -p projects # or wherever you set it to be
+# For community edition
 $ mkdir -p mergin_db # or wherever you set it to be
-$ sudo chown -R  901:999 ./projects/
-$ sudo chmod g+s ./projects/
-$ docker-compose -f docker-compose.yml up
+$ sh ../common/set_permissions.sh projects
+$ docker-compose -f docker-compose.yml up -d
+
+# For enterprise edition
+$ mkdir -p mergin-db-enterprise # or wherever you set it to be
+$ sh ../common/set_permissions.sh data
+$ sh ../common/set_permissions.sh map_data
+$ docker-compose -f docker-compose.yml up -d
+$ docker-compose -f docker-compose.maps.yml up -d # Run maps stack separately
 ```
 ​​
 ### Initialise database
diff --git a/src/server/security/index.md b/src/server/security/index.md
@@ -8,7 +8,7 @@ Further security enhancements should be implemented by experts in accordance to
 :::
 For security and privacy reasons <MainPlatformName /> deployments should enable HTTPS secured connection via certificate file.
 
-We provide a template configuration file <GitHubRepo id="MerginMaps/server/blob/master/ssl-proxy.conf" desc="ssl-proxy.conf" />as base for your configuration.
+We provide a template configuration file <GitHubRepo id="MerginMaps/server/blob/master/deployment/common/ssl-proxy.conf" desc="ssl-proxy.conf" />as base for your configuration.
 
 Let's have a quick look at the main sections:
 
diff --git a/src/server/upgrade/index.md b/src/server/upgrade/index.md
@@ -11,6 +11,56 @@ Make sure to always back up your database data before doing a migration.
 [[toc]]
 
 
+## Migration guide from 2025.2.x to 2025.3.x
+
+<MigrationType type="EE" />
+
+::: tip Changes on deployment behaviour
+Release 2025.3.x brings some changes on <MainPlatformName /> docker compose orchestration deployment procedure.
+:::
+
+Get the latest <GitHubRepo id="MerginMaps/server/blob/master/deployment/enterprise/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2025.3.0`.
+Perform the migration:
+
+1. Stop your running docker containers
+   ```bash
+    $ docker compose -f docker-compose.yml down # or similarly, based on your previous deployment
+    # INFO: After shutdown update the docker-compose.yml file to latest release
+   ```
+2. Please clone the <GitHubRepo id="MerginMaps/server/blob/master/" desc="server repository" /> or download <GitHubRepo id="MerginMaps/server/blob/master/deployment/" desc="deployment folder" />
+   ```bash    
+    $ cd server/deployment/enterprise
+   ```
+3. If you plan to use the new webmaps stacks, adapt your existing `.prod.env` and `docker-compose.yml` files. Move/copy them to the `enterprise` deployment folder  
+   ```bash
+    $ cp /some/path/.prod.env . # assuming you are located in `server/deployment/enterprise`
+    $ cp /some/path/docker-compose.yml . # assuming you are located in `server/deployment/enterprise`
+   ```
+4. Start up your docker containers
+   ```bash
+    $ docker compose -f docker-compose.yml -d up # or similarly, based on your deployment
+    $ docker compose -f docker-compose.maps.yml -d up # If you want to deploy webmaps stack
+   ```
+5. Check that you are on correct versions (`ba5051218de4`, `ba5ae5972c4a`).
+    ```bash
+    $ docker exec merginmaps-server flask db current
+    INFO  [alembic.runtime.migration] Context impl PostgresqlImpl.
+    INFO  [alembic.runtime.migration] Will assume transactional DDL.
+    ba5051218de4 (head)
+    ba5ae5972c4a (head)
+    ```
+
+   - If you do not see the version numbers at all, run the following commands:
+    ```bash
+    $ docker exec merginmaps-server flask db stamp ba5051218de4
+    $ docker exec merginmaps-server flask db stamp ba5ae5972c4a
+    ```
+6. Run the database migration:
+    ```bash
+    $ docker exec merginmaps-server flask db upgrade community@5ad13be6f7ef
+    $ docker exec merginmaps-server flask db upgrade enterprise@819e6b20ee93
+    ```
+
 ## Migration guide from 2024.2.x to 2025.2.x (CE)
 
 ::: tip Before you upgrade!
@@ -21,7 +71,7 @@ Previous individual `server` container is replaced by 3 service dedicated contai
 
 <MigrationType type="CE" />
 
-Get the latest <GitHubRepo id="MerginMaps/server/blob/master/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2025.2.2`.
+Get the latest <GitHubRepo id="MerginMaps/server/blob/master/deployment/community/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2025.2.2`.
 Perform the migration:
 
 1. Stop your running docker containers
@@ -34,6 +84,7 @@ Perform the migration:
     ```bash
     SECURITY_EMAIL_SALT='<YOUR STRONG HASH>'
     SECURITY_BEARER_SALT='<YOUR STRONG HASH>'
+    PORT=5000
     ```
 
 3. Start up your docker containers
@@ -80,7 +131,7 @@ Previous individual `server` container is replaced by 3 service dedicated contai
 
 <MigrationType type="EE" />
 
-Get the latest <GitHubRepo id="MerginMaps/server/blob/master/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2025.2.0`.
+Get the latest <GitHubRepo id="MerginMaps/server/blob/master/deployment/enterprise/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2025.2.0`.
 Perform the migration:
 
 1. Stop your running docker containers and build the new images
@@ -93,6 +144,7 @@ Perform the migration:
     ```bash
     SECURITY_EMAIL_SALT='<YOUR STRONG HASH>'
     SECURITY_BEARER_SALT='<YOUR STRONG HASH>'
+    PORT=5000
     ```
 
 3. Start up your docker containers
@@ -131,7 +183,7 @@ Perform the migration:
 
 ## Migration guide from 2024.3.x to 2024.4.x
 
-Get the latest <GitHubRepo id="MerginMaps/server/blob/master/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2024.4.0`.
+Get the latest <GitHubRepo id="MerginMaps/server/blob/master/deployment/enterprise/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2024.4.0`.
 Perform the migration:
 
 <MigrationType type="EE" />
@@ -163,7 +215,7 @@ Perform the migration:
 
 ## Migration guide from 2024.2.x to 2024.3.x
 
-Get the latest <GitHubRepo id="MerginMaps/server/blob/master/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2024.3.0`.
+Get the latest <GitHubRepo id="MerginMaps/server/blob/master/deployment/enterprise/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2024.3.0`.
 Perform the migration:
 
 <MigrationType type="EE" />
@@ -194,7 +246,7 @@ Perform the migration:
 
 ## Migration guide from 2023.6.1 to 2024.2.x (CE)
 
-Get the latest <GitHubRepo id="MerginMaps/server/blob/master/docker-compose.yml" desc="docker-compose file" />  or update docker images manually.
+Get the latest <GitHubRepo id="MerginMaps/server/blob/master/deployment/community/docker-compose.yml" desc="docker-compose file" />  or update docker images manually.
 
 <MigrationType type="CE" />
 Update image to `2024.2.2` and perform the migration:
@@ -259,7 +311,7 @@ Update image to `2024.2.1` and perform the migration:
 
 -----
 
-Get the latest <GitHubRepo id="MerginMaps/server/blob/master/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2023.6.1`.
+Get the latest <GitHubRepo id="MerginMaps/server/blob/master/deployment/community/docker-compose.yml" desc="docker-compose file" />  or update docker images manually to version `2023.6.1`.
 Perform the migration:
 
 <MigrationType type="CE" />
@@ -343,7 +395,7 @@ $ docker-compose -f docker-compose.yml stop
 $ git pull
 ```
 
- 6. Set environment variables (<GitHubRepo desc=".prod.env" id="MerginMaps/server/blob/master/.prod.env" /> file). **Important** ⚠️
+ 6. Set environment variables `.prod.env`. **Important** ⚠️
 
 <MigrationType type="CE" />
 
