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]]
For testing or personal usage a 4GB memory machine is enough to run . For small teams we recommend using a dedicated host machine with 8 GB of memory.
For large teams and/or HA, please contact our .
The requirements for CPU and persistent storage depend largely on the frequency of project updates and the anticipated size of stored data. We advise you to install a monitoring solution alongside in order to get some metrics for your use case.
The images are stored on publicly accessible .
Follow the deployment guidelines to install and configure it.
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.
Follow these steps to run a local instance.
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
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 initIf 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>:::
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.