Skip to content

Commit 03ac461

Browse files
authored
Merge pull request #603 from MerginMaps/server-environment-formatting
server environment page formatting
2 parents 77c22c6 + ddf3d90 commit 03ac461

File tree

1 file changed

+24
-11
lines changed

1 file changed

+24
-11
lines changed

src/server/environment/index.md

+24-11
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1+
---
2+
prev:
3+
text: 'Administer'
4+
link: '../administer/'
5+
6+
next:
7+
text: 'Administration Panel'
8+
link: '../dashboard/'
9+
---
10+
111
# Configure environment
212

13+
314
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).
415
5-
#### Server basics
16+
## Server basics
617
Variables marked with star ⭐️ need to be modified for production use.
718

819
| Variable name | Type | Default | Description |
@@ -12,7 +23,7 @@ Variables marked with star ⭐️ need to be modified for production use.
1223
| `CONTACT_EMAIL` | string | `` | Email contact for application administrator. |
1324
| `SERVICE_ID` | string | | Deployment UUID. Auto-generated on the first run. |
1425
15-
#### Security settings (important for production use)🛡️
26+
## Security settings (important for production use)🛡️
1627
Security settings are important for production use.
1728

1829
| Variable name | Type | Default | Description |
@@ -25,7 +36,7 @@ Security settings are important for production use.
2536
| `WTF_CSRF_ENABLED` | Boolean | `true` | Enable CSRF protection. It is strongly recommended to have this on. |
2637
| `WTF_CSRF_TIME_LIMIT` | integer | `86400` | Lifetime of CSRF token in seconds. When expired, users need to refresh it. |
2738
28-
#### Database settings
39+
## Database settings
2940
Mergin Maps uses PostgreSQL database to store its data.
3041

3142
| Variable name | Type | Default | Description |
@@ -41,7 +52,7 @@ Mergin Maps uses PostgreSQL database to store its data.
4152
| `DB_USER` ⭐️ | string |`postgres` | PostgreSQL user to connect to <MainPlatformName /> database. |
4253
4354

44-
#### User management
55+
## User management
4556
Settings for managing users.
4657
<ServerType type="EE" />
4758

@@ -50,7 +61,7 @@ Settings for managing users.
5061
| `USER_SELF_REGISTRATION` | Boolean | `true` | Users can register themselves. If disabled, they must be invited or registered by superuser. |
5162
| `ENABLE_SUPERADMIN_ASSIGNMENT` | Boolean | `true` | If set to false, you will not be able to assign super admin role to user from admin panel. |
5263

53-
#### Permission management
64+
## Permission management
5465
<ServerType type="CE" />
5566
To ease the process of permission (user) management, you can set the following global variables that apply to all registered users.
5667

@@ -61,7 +72,7 @@ To ease the process of permission (user) management, you can set the following g
6172
| `GLOBAL_WRITE` | Boolean | `false` | All registered users have write access (can sync) to all projects. |
6273

6374

64-
#### Sending Emails
75+
## Sending Emails
6576
​Mergin Maps can connect to a SMTP server to send notifications and password recovery emails.
6677

6778
| Variable name | Type | Default | Description |
@@ -79,7 +90,7 @@ To ease the process of permission (user) management, you can set the following g
7990

8091
If you have issues with sending emails, follow [troubleshooting](../troubleshoot/) page.
8192

82-
#### Workspace management
93+
## Workspace management
8394
Workspace settings.
8495
<ServerType type="CE" />
8596

@@ -98,7 +109,7 @@ Workspace settings.
98109
| `WORKSPACE_EXPIRATION` | integer | `7` | Expiration time in days for deleted workspaces before removed completely. |
99110
| `USER_WORKSPACES_ALLOWED` | Boolean | `true` | Allow users to create their own workspaces else it is available for superuser only |
100111

101-
#### Data synchronisation and management
112+
## Data synchronisation and management
102113
Other settings related to data management.
103114

104115
| Variable name | Type | Default | Description |
@@ -118,15 +129,15 @@ Other settings related to data management.
118129
| `TEMP_EXPIRATION` | integer | `7` | Time in days after files in a temporary folder are permanently deleted. |
119130

120131

121-
#### Celery asynchronous tasks
132+
## Celery asynchronous tasks
122133
Mergin Maps is using Celery and Redis to perform asynchronous tasks or doing regular jobs.
123134

124135
| Variable name | Type | Default | Description |
125136
|-----------------------|------|---------------------------------|-------------|
126137
|`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. |
127138
|`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. |
128139

129-
#### WebMaps
140+
## WebMaps
130141
<ServerType type="EE" />
131142

132143
| Variable name | Type | Default | Description |
@@ -139,4 +150,6 @@ Mergin Maps is using Celery and Redis to perform asynchronous tasks or doing reg
139150
Your webmaps won’t display the default background map unless we enable them on our side. To do that, please [contact our support team](mailto:[email protected]?subject=Enable%20default%20background%20maps%20on%20Enterprise%20server&body=Dear%20support%2C%0A%0AI%27d%20like%20to%20request%20enabling%20background%20maps%20for%20our%20Enterprise%20edition%20server.%20%0AThe%20server%20is%20hosted%20at%3A%20%3Curl%3E) and share your server’s URL.
140151

141152
Alternatively, you can set up your own background map.
142-
:::
153+
:::
154+
155+

0 commit comments

Comments
 (0)