Skip to content

Commit be759d0

Browse files
authored
Merge pull request #560 from MerginMaps/559-document-new-server-check-command
Added some notes related to server check script #559
2 parents b507582 + d3a3b40 commit be759d0

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

src/server/install/index.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,43 @@ $ docker exec merginmaps-server flask user create <username> <password> --is-adm
6161
### Setup environment
6262
6363
Now tweak deployment settings by modifying environment variables. You have to fix all variables marked as required in this list of [environment variables](../administer/environment.md). Some of the most common issues with custom deployments are listed in the [troubleshoot](../troubleshoot/index.md) section.
64+
65+
### Test deployment
66+
67+
In order to test your deployment there are some utility commands to perform basic checks.
68+
69+
Overall basic check on server configuration:
70+
71+
```shell
72+
$ docker exec merginmaps-server flask server check
73+
```
74+
75+
Output will be similar to the next snippet. The utility will try to provide some background information if some needed environment variable is missing or wrongly set (ex: `MERGIN_BASE_URL`)
76+
77+
```shell
78+
# Server health check
79+
80+
Mergin Maps edition: Enterprise Edition
81+
Mergin Maps version: 2025.2.0
82+
Error: No base URL set. Please set MERGIN_BASE_URL environment variable
83+
Error: No contact email set. Please set CONTACT_EMAIL environment variable
84+
Database initialized properly
85+
Celery running properly
86+
```
87+
88+
To test email configuration:
89+
90+
```shell
91+
$ docker exec merginmaps-server flask send-check-email --email me@myorg.com
92+
```
93+
94+
By default, email notifications are disabled, so output will be similar to this:
95+
96+
```shell
97+
# Sending check email to specified email address me@myorg.com.
98+
99+
Error: Sending emails is disabled. Please set MAIL_SUPPRESS_SEND=False to enable sending emails.
100+
101+
```
102+
103+
To enable them, set variable `MAIL_SUPPRESS_SEND` in accordance to above and fill all `MAIL_*` related variables with your company SMTP server configuration.

0 commit comments

Comments
 (0)