Skip to content

Commit 350f7d6

Browse files
committed
Added section related to https deployment #556
1 parent 8ef83e1 commit 350f7d6

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed

Diff for: src/.vuepress/sidebar/en.js

+1
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ module.exports = {
125125
children: [
126126
'/server/',
127127
'/server/install/',
128+
'/server/security/',
128129
'/server/upgrade/',
129130
'/server/administer/',
130131
'/server/troubleshoot/',

Diff for: src/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ The ecosystem consist of various components:
105105
## Custom Server
106106
- [Overview](./server/)
107107
- [Install](./server/install/)
108+
- [Security](./server/security/)
108109
- [Upgrade](./server/upgrade/)
109110
- [Administer](./server/administer/)
110111
- [Troubleshoot Custom Servers](./server/troubleshoot/)

Diff for: src/server/security/index.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Secure Mergin Maps installation
2+
3+
For security and privacy reasons Mergin Maps deployments should enable HTTPS secured connection via certificate file.
4+
5+
We provide a template configuration file [ssl-proxy.conf](https://github.com/MerginMaps/server/blob/master/ssl-proxy.conf) as base for your costumization.
6+
7+
Let's have a quick look at the main sections:
8+
9+
``` shell
10+
server {
11+
listen 443 ssl;
12+
server_name merginmaps.company.com; # FIXME
13+
client_max_body_size 4G;
14+
15+
...
16+
```
17+
18+
Here we enable SSL via the defaul `443` port and configure name-based HTTPS server via `server_name`. Here you should change this according to your target server name.
19+
20+
We don't recommend setting a `client_max_body_size` higher than specified, because that might lead to timeouts while uploading your data to Mergin Maps.
21+
22+
Next, you need to point your certificate files to NGINX configuration. This is done on the next lines on the secured configuration:
23+
24+
``` shell
25+
...
26+
ssl_certificate_key /etc/letsencrypt/live/merginmaps.company.com/privkey.pem; # FIXME
27+
ssl_certificate /etc/letsencrypt/live/merginmaps.company.com/fullchain.pem; # FIXME
28+
...
29+
```
30+
31+
The above example uses automated keys generated by Certbot. For more information, visit [CertBot](https://certbot.eff.org/instructions) website and check how you can generate your own keys.
32+
33+
Lastly, adjust the provided nginx `docker compose` deployment file, on the following [section](https://github.com/MerginMaps/server/blob/master/docker-compose.yml#L95):
34+
35+
``` shell
36+
- "8080:8080"
37+
volumes:
38+
- ./projects:/data # map data dir to host
39+
- - ./nginx.conf:/etc/nginx/conf.d/default.conf
40+
+ - ./ssl-proxy.conf:/etc/nginx/conf.d/default.conf
41+
- ./logs:/var/log/nginx/
42+
networks:
43+
- merginmaps
44+
```

0 commit comments

Comments
 (0)