From 356961b17f109e64d19a5b3fb56975a8d031baa0 Mon Sep 17 00:00:00 2001 From: Martin Varga Date: Thu, 16 May 2024 13:59:00 +0200 Subject: [PATCH 1/2] Add config variables for EE version --- src/server/administer/environment.md | 30 +++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/src/server/administer/environment.md b/src/server/administer/environment.md index 02f221e1..3f68b2a5 100644 --- a/src/server/administer/environment.md +++ b/src/server/administer/environment.md @@ -33,12 +33,21 @@ Mergin Maps uses PostgreSQL database to store its data. | `DB_HOST` | string | `db` | Database host. Mapped to docker-compose service name. | | `DB_PASSWORD` ⭐️ | string |`postgres` | PostgreSQL user password. | | `DB_PORT` | integer | `5432` | Database port. If non-default, it should match the port exposed in the docker-compose file. | -| `DB_POOL_MAX_OVERFLOW=10` | integer | `10` | Database `max_overflow` limit for [SQLAlchemy](https://docs.sqlalchemy.org/en/14/core/engines.html). | +| `DB_POOL_MAX_OVERFLOW` | integer | `10` | Database `max_overflow` limit for [SQLAlchemy](https://docs.sqlalchemy.org/en/14/core/engines.html). | | `DB_POOL_SIZE` | integer | `2` | Database pool size for SQLAlchemy. With overflow determines the maximum of concurrent connections to the database. | | `DB_POOL_TIMEOUT` | integer | `300` | Database pool timeout for SQLAlchemy. | | `DB_USER` ⭐️ | string |`postgres` | PostgreSQL user to connect to database. | ​ + +#### User management +Settings for managing users. + +| Variable name | Type | Default | Description | +|---------------------------|---------|-------------|---------------------------| +| `USER_SELF_REGISTRATION` | Boolean | `true` | Users can register themselves. If disabled, they must be invited or registered by superuser. | + #### Permission management + To ease the process of permission (user) management, you can set the following global variables that apply to all registered users. | Variable name | Type | Default | Description | @@ -62,14 +71,29 @@ To ease the process of permission (user) management, you can set the following g | `MAIL_SERVER` | string |`localhost`| SMTP mail server host. | | `MERGIN_LOGO_URL` | string | `null` | Link to logo in emails. | +#### Workspace management +Workspace settings. + + +| Variable name | Type | Default | Description | +|------------------------------|---------|-------------|---------------------------| +| `GLOBAL_WORKSPACE` ⭐️ | string | `mergin` | Namespace (part of URL) for all projects. All projects belong to this single workspace with certain permissions (see below). | +| `GLOBAL_STORAGE` ⭐️ | integer |`10737418240`| Storage limit can use to store projects (last version) in bytes (default is 10 GB). Should be reasonably large. | + + +| Variable name | Type | Default | Description | +|------------------------------|---------|-------------|---------------------------| +| `WORKSPACE_STORAGE_SIZE` ⭐️ | integer |`524288000`| Storage limit workspace can use to store projects (last version) in bytes (default is 500 MB). | +| `WORKSPACE_INVITATION_EXPIRATION` | integer |`7`| Expiration limit for pending invitation in days. | +| `PROJECT_TRANSFER_EXPIRATION` | integer |`7`| Expiration limit for pending project transfer in days. | +| `WORKSPACE_EXPIRATION` | integer |`7`| Expiration time in days for deleted workspaces before removed completely. | +| `USER_WORKSPACES_ALLOWED` | Boolean |`true`| Allow users to create their own workspaces else it is available for superuser only | #### Data synchronisation and management Other settings related to data management. | Variable name | Type | Default | Description | |------------------------------|---------|-------------|---------------------------| -| `GLOBAL_WORKSPACE` ⭐️ | string | `mergin` | Namespace (part of URL) for all projects. All projects belong to this single workspace with certain permissions (see below). | -| `GLOBAL_STORAGE` ⭐️ | integer |`10737418240`| Storage limit can use to store projects (last version) in bytes (default is 10 GB). Should be reasonably large. | | `LOCAL_PROJECTS` | string | `./projects` | Directory to store projects on a container. Please refer to volume mapping in docker-compose file. | | `TEMP_DIR` | string | Result of `gettempdir()` call | Trash directory for temp files being cleaned regularly. Please refer to volume mapping in docker-compose file. | | `MAINTENANCE_FILE` | string |`/data/MAINTENANCE`| File to indicate server is in maintenance - read only mode. Please refer to volume mapping in docker-compose file. | From 3e68acc09961d1cf41cdd9b2ab31f2d4dda4ca96 Mon Sep 17 00:00:00 2001 From: Martin Varga Date: Thu, 16 May 2024 14:21:59 +0200 Subject: [PATCH 2/2] Clarify global workspace settings --- src/server/administer/environment.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/server/administer/environment.md b/src/server/administer/environment.md index 3f68b2a5..84ba59dc 100644 --- a/src/server/administer/environment.md +++ b/src/server/administer/environment.md @@ -75,10 +75,10 @@ To ease the process of permission (user) management, you can set the following g Workspace settings. -| Variable name | Type | Default | Description | -|------------------------------|---------|-------------|---------------------------| -| `GLOBAL_WORKSPACE` ⭐️ | string | `mergin` | Namespace (part of URL) for all projects. All projects belong to this single workspace with certain permissions (see below). | -| `GLOBAL_STORAGE` ⭐️ | integer |`10737418240`| Storage limit can use to store projects (last version) in bytes (default is 10 GB). Should be reasonably large. | +| Variable name | Type | Default | Description | +|------------------------------|---------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `GLOBAL_WORKSPACE` ⭐️ | string | `mergin` | Common workspace name for all projects. All projects belong to this single workspace with certain permissions. Projects are then referenced with this name as part of URL, e.g. `/mergin/projectA`, `/mergin/projectB`. | +| `GLOBAL_STORAGE` ⭐️ | integer |`10737418240`| Storage limit can use to store projects (last version) in bytes (default is 10 GB). Should be reasonably large. | | Variable name | Type | Default | Description |