Skip to content

index.md

Latest commit

 

History

History
104 lines (69 loc) · 4.65 KB

index.md

File metadata and controls

104 lines (69 loc) · 4.65 KB

Install

Installation guide will help you to install your or to the latest server version. The main Cloud is always up-to-date and managed by team. Read more about server platforms in overview article

[[toc]]

Installation System Requirements

We recommend using a dedicated host machine with 8 GB of memory. The requirements for CPU and persistent storage depend largely on the frequency of project updates and the anticipated size of the data you expect to store respectively.

Mergin Maps CE Docker Images

The images are stored on publicly accessible .

Follow the deployment guidelines to install and configure it.

Mergin Maps EE Docker Images

The enhanced features are only available on specific Docker images stored on Lutra Consulting's private AWS repository. To get access, you need your contract and licence from our .

Afterwards, you can follow this guide to retrieve your images.

Once you have the images on your side, follow the deployment guidelines and have running on a target instance in your infrastructure.

Deployment

Follow these steps to run a local instance.

Start docker containers

Provided that docker and docker-compose are installed on your host, running stack should be as simple as running docker-compose. However, before doing that you would need to configure your server setup via environment variables in file.

Once configured, you can run:

$ mkdir -p projects # or wherever you set it to be
$ mkdir -p mergin_db # or wherever you set it to be
$ sudo chown -R  901:999 ./projects/
$ sudo chmod g+s ./projects/
$ docker-compose -f docker-compose.yml up

​​

Initialise database

If server is started for the first time, database needs to be initialised and super-user created. Use the init command which will perform it automatically (the command generates password for the admin account):

$ docker exec merginmaps-server flask init

If you don't have CONTACT_EMAIL variable set, you will be asked to provide a super user email using the -e/--email option. The init will also check your server setup (celery jobs, emails, etc.) and print out a list of missing variables. If you see any errors in the console output, you can run the command again as the database and super user will not be re-initialised.

:::tip If you want to create another users manually, you can use the following command:

$ docker exec merginmaps-server flask user create <username> <password> --is-admin --email <email>

:::

Setup environment

​ Now tweak deployment settings by modifying environment variables. You have to fix all variables marked as required in this list of environment variables. Some of the most common issues with custom deployments are listed in the troubleshoot section.

Test deployment

In order to test your deployment there are some utility commands to perform basic checks.

Overall basic check on server configuration:

$ docker exec merginmaps-server flask server check

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)

  # Server health check

  Mergin Maps edition: Enterprise Edition
  Mergin Maps version: 2025.2.0  
  Error: No base URL set. Please set MERGIN_BASE_URL environment variable
  Error: No contact email set. Please set CONTACT_EMAIL environment variable
  Database initialized properly
  Permissions granted for /data folder
  Celery running properly

To test email configuration:

$ docker exec merginmaps-server flask send-check-email --email me@myorg.com

By default, email notifications are disabled, so output will be similar to this:

    # Sending check email to specified email address me@myorg.com.

  Error: Sending emails is disabled. Please set MAIL_SUPPRESS_SEND=False to enable sending emails.

To enable them, set variable MAIL_SUPPRESS_SEND in accordance to above and fill all MAIL_* related variables with your company SMTP server configuration.