Skip to content

Commit 0503192

Browse files
authored
Merge pull request #479 from MerginMaps/add_ee_config_variables
Add config variables for EE version
2 parents 11438ce + 3e68acc commit 0503192

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

src/server/administer/environment.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,21 @@ Mergin Maps uses PostgreSQL database to store its data.
3333
| `DB_HOST` | string | `db` | Database host. Mapped to docker-compose service name. |
3434
| `DB_PASSWORD` ⭐️ | string |`postgres` | PostgreSQL user password. |
3535
| `DB_PORT` | integer | `5432` | Database port. If non-default, it should match the port exposed in the docker-compose file. |
36-
| `DB_POOL_MAX_OVERFLOW=10` | integer | `10` | Database `max_overflow` limit for [SQLAlchemy](https://docs.sqlalchemy.org/en/14/core/engines.html). |
36+
| `DB_POOL_MAX_OVERFLOW` | integer | `10` | Database `max_overflow` limit for [SQLAlchemy](https://docs.sqlalchemy.org/en/14/core/engines.html). |
3737
| `DB_POOL_SIZE` | integer | `2` | Database pool size for SQLAlchemy. With overflow determines the maximum of concurrent connections to the database. |
3838
| `DB_POOL_TIMEOUT` | integer | `300` | Database pool timeout for SQLAlchemy. |
3939
| `DB_USER` ⭐️ | string |`postgres` | PostgreSQL user to connect to <MainPlatformName /> database. |
4040
41+
42+
#### User management
43+
Settings for managing users.
44+
<ServerType type="EE" />
45+
| Variable name | Type | Default | Description |
46+
|---------------------------|---------|-------------|---------------------------|
47+
| `USER_SELF_REGISTRATION` | Boolean | `true` | Users can register themselves. If disabled, they must be invited or registered by superuser. |
48+
4149
#### Permission management
50+
<ServerType type="CE" />
4251
To ease the process of permission (user) management, you can set the following global variables that apply to all registered users.
4352

4453
| Variable name | Type | Default | Description |
@@ -62,14 +71,29 @@ To ease the process of permission (user) management, you can set the following g
6271
| `MAIL_SERVER` | string |`localhost`| SMTP mail server host. |
6372
| `MERGIN_LOGO_URL` | string | `null` | Link to logo in emails. |
6473

74+
#### Workspace management
75+
Workspace settings.
76+
<ServerType type="CE" />
77+
78+
| Variable name | Type | Default | Description |
79+
|------------------------------|---------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
80+
| `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`. |
81+
| `GLOBAL_STORAGE` ⭐️ | integer |`10737418240`| Storage limit <MainPlatformName /> can use to store projects (last version) in bytes (default is 10 GB). Should be reasonably large. |
82+
83+
<ServerType type="EE" />
84+
| Variable name | Type | Default | Description |
85+
|------------------------------|---------|-------------|---------------------------|
86+
| `WORKSPACE_STORAGE_SIZE` ⭐️ | integer |`524288000`| Storage limit workspace can use to store projects (last version) in bytes (default is 500 MB). |
87+
| `WORKSPACE_INVITATION_EXPIRATION` | integer |`7`| Expiration limit for pending invitation in days. |
88+
| `PROJECT_TRANSFER_EXPIRATION` | integer |`7`| Expiration limit for pending project transfer in days. |
89+
| `WORKSPACE_EXPIRATION` | integer |`7`| Expiration time in days for deleted workspaces before removed completely. |
90+
| `USER_WORKSPACES_ALLOWED` | Boolean |`true`| Allow users to create their own workspaces else it is available for superuser only |
6591

6692
#### Data synchronisation and management
6793
Other settings related to data management.
6894

6995
| Variable name | Type | Default | Description |
7096
|------------------------------|---------|-------------|---------------------------|
71-
| `GLOBAL_WORKSPACE` ⭐️ | string | `mergin` | Namespace (part of URL) for all projects. All projects belong to this single workspace with certain permissions (see below). |
72-
| `GLOBAL_STORAGE` ⭐️ | integer |`10737418240`| Storage limit <MainPlatformName /> can use to store projects (last version) in bytes (default is 10 GB). Should be reasonably large. |
7397
| `LOCAL_PROJECTS` | string | `./projects` | Directory to store projects on a container. Please refer to volume mapping in docker-compose file. |
7498
| `TEMP_DIR` | string | Result of `gettempdir()` call | Trash directory for temp files being cleaned regularly. Please refer to volume mapping in docker-compose file. |
7599
| `MAINTENANCE_FILE` | string |`/data/MAINTENANCE`| File to indicate server is in maintenance - read only mode. Please refer to volume mapping in docker-compose file. |

0 commit comments

Comments
 (0)