diff --git a/src/server/install/ee/assign_permission_2.jpg b/src/server/install/ee/assign_permission_2.jpg deleted file mode 100644 index a8933be5..00000000 Binary files a/src/server/install/ee/assign_permission_2.jpg and /dev/null differ diff --git a/src/server/install/ee/assign_permission_2.xcf b/src/server/install/ee/assign_permission_2.xcf deleted file mode 100644 index 9126adb5..00000000 Binary files a/src/server/install/ee/assign_permission_2.xcf and /dev/null differ diff --git a/src/server/install/ee/assign_permissions.jpg b/src/server/install/ee/assign_permissions.jpg deleted file mode 100644 index 918cd62f..00000000 Binary files a/src/server/install/ee/assign_permissions.jpg and /dev/null differ diff --git a/src/server/install/ee/assign_permissions.xcf b/src/server/install/ee/assign_permissions.xcf deleted file mode 100644 index 9e8ac71a..00000000 Binary files a/src/server/install/ee/assign_permissions.xcf and /dev/null differ diff --git a/src/server/install/ee/create_IAM_user.jpg b/src/server/install/ee/create_IAM_user.jpg deleted file mode 100644 index 4d66364a..00000000 Binary files a/src/server/install/ee/create_IAM_user.jpg and /dev/null differ diff --git a/src/server/install/ee/create_IAM_user.xcf b/src/server/install/ee/create_IAM_user.xcf deleted file mode 100644 index 3b85cca4..00000000 Binary files a/src/server/install/ee/create_IAM_user.xcf and /dev/null differ diff --git a/src/server/install/ee/create_access_key.jpg b/src/server/install/ee/create_access_key.jpg deleted file mode 100644 index 7c3aef11..00000000 Binary files a/src/server/install/ee/create_access_key.jpg and /dev/null differ diff --git a/src/server/install/ee/create_access_key.xcf b/src/server/install/ee/create_access_key.xcf deleted file mode 100644 index 11e8396c..00000000 Binary files a/src/server/install/ee/create_access_key.xcf and /dev/null differ diff --git a/src/server/install/ee/create_aws_account.jpg b/src/server/install/ee/create_aws_account.jpg deleted file mode 100644 index 76876603..00000000 Binary files a/src/server/install/ee/create_aws_account.jpg and /dev/null differ diff --git a/src/server/install/ee/create_aws_account.xcf b/src/server/install/ee/create_aws_account.xcf deleted file mode 100644 index 0b3f68dc..00000000 Binary files a/src/server/install/ee/create_aws_account.xcf and /dev/null differ diff --git a/src/server/install/ee/docker_pull.jpg b/src/server/install/ee/docker_pull.jpg deleted file mode 100644 index c038a8be..00000000 Binary files a/src/server/install/ee/docker_pull.jpg and /dev/null differ diff --git a/src/server/install/ee/docker_pull.xcf b/src/server/install/ee/docker_pull.xcf deleted file mode 100644 index cacb2d17..00000000 Binary files a/src/server/install/ee/docker_pull.xcf and /dev/null differ diff --git a/src/server/install/ee/find_name_and_id.jpg b/src/server/install/ee/find_name_and_id.jpg deleted file mode 100644 index 9b21e608..00000000 Binary files a/src/server/install/ee/find_name_and_id.jpg and /dev/null differ diff --git a/src/server/install/ee/find_name_and_id.xcf b/src/server/install/ee/find_name_and_id.xcf deleted file mode 100644 index df5e2b05..00000000 Binary files a/src/server/install/ee/find_name_and_id.xcf and /dev/null differ diff --git a/src/server/install/ee/index.md b/src/server/install/ee/index.md index fbdef8ba..4e8b3f14 100644 --- a/src/server/install/ee/index.md +++ b/src/server/install/ee/index.md @@ -1,103 +1,41 @@ --- -description: Mergin Maps Enterprise Edition enhanced features are only available on specific Docker images on our private AWS repository. Here is how to retrieve them. +description: Mergin Maps Enterprise Edition enhanced features are only available on specific Docker images on our private Docker Hub repository. Here is how to retrieve them. --- # Download your Mergin Maps EE images - -To get access to your docker images, you need your contract and licence from our . If you do not have them, please contact our team. The repository is private and our team needs to secure you the access to them so you are able to follow these steps. +During your onboarding you'll be provided a personal token (PAT) to access Lutra's private Docker Hub were we host Docker images. -[[toc]] +Once you receive it you can perform Docker login in two ways. -## Amazon Web Services (AWS) +## Docker login from CLI -### Create (root) AWS account - -::: warning -If your organisation already uses AWS cloud services and has a root user, skip this step. - -Maintenance of cloud accounts and security requires deep knowledge. does not take responsibility for incorrectly set up accounts. The AWS account and its maintenance is the responsibility of your user. -::: - -- Go to [aws.amazon.com](https://aws.amazon.com/) and create new root account - -![Create AWS account](./create_aws_account.jpg "Create AWS account") - -- Continue with all steps and verify your account - -### Create IAM user - -::: warning -If your organisation already uses AWS cloud services and has a root user, skip this step. - -Maintenance of cloud accounts and security requires deep knowledge. does not take responsibility for incorrectly set up accounts. The AWS account and its maintenance is the responsibility of your user. -::: - - -- Login as the root user - -![Login as root to AWS](./root_login.jpg "Login as root to AWS") - -- Create an IAM user by searching in the console “IAM” and creating a new user. - -![Create IAM user](./create_IAM_user.jpg "Create IAM user") - -- Assign the IAM user administrator account permissions. Look for permission. - -![Assign AWS permissions](./assign_permissions.jpg "Assign AWS permissions") - -- Review and add it to your new IAM user account - -![Finish assigning AWS permissions](./assign_permission_2.jpg "Finish assigning AWS permissions") - -- Logout from root AWS account - -### Identify Account ID and IAM user name - -Account ID and IAM user names are needed for assigning the permissions to docker images by operations team. - -::: warning - will never ask you to share an IAM or root login password or other access details to your accounts. -::: - -- Login to your IAM account - -![Login as IAM user to AWS](./login_IAM.jpg "Login as IAM user to AWS") - -- Now create CLI access key - -![Create access keys](./create_access_key.jpg "Create access keys") - -- Note down ACCESS_ID and SECRET for AWS command line client - -![Console login details](./find_name_and_id.jpg "Console login details") - -- Send Account ID and IAM user name to -- Wait for confirmation that we have shared the ECR repository with you. This can take up to 5 working days. - -## Download Docker Images - -::: warning -To be able to download the images, you need to have permission to do so for your IAM user that is granted by -::: +```bash + docker login -u ee-support@merginmaps.com + + i Info → A Personal Access Token (PAT) can be used instead. + To create a PAT, visit https://app.docker.com/settings + + + Password: +``` +Once you are prompted to fill in the password, you can type the provided token during onboarding. - - Open command line and write (you may need to change to your IAM account region). You will be asked for your id and secret to be used. +Alternatively, you can pass the token via `--password-stdin`, although it's not safe to keep your token on a plain text file. -``` -aws ecr get-login-password --region eu-west-1 | docker login --username AWS --password-stdin 433835555346.dkr.ecr.eu-west-1.amazonaws.com +```bash + cat ~/my_token.txt | docker login -u ee-support@merginmaps.com --password-stdin ``` - - Now list docker images that are shared with you (`mergin-ee-front` is frontend application, `mergin-ee-back` is backend application) - -``` -aws ecr describe-images --repository-name mergin/mergin-ee-front --registry-id 433835555346 --region eu-west-1 -aws ecr describe-images --repository-name mergin/mergin-ee-back --registry-id 433835555346 --region eu-west-1 -``` +## Credential stores - - Select the tag you want to use and download image, e.g. `2023.6.1-ee` or any other from the list of images +Please follow official Docker documentation on how to use [credential stores](https://docs.docker.com/reference/cli/docker/login/#credential-stores) -``` -docker pull 433835555346.dkr.ecr.eu-west-1.amazonaws.com/mergin/mergin-ee-back:2023.6.1-ee -``` +## Docker Pull -![Docker pull of Mergin Maps EE image](./docker_pull.jpg "Docker pull of Mergin Maps EE image") +After login, please confirm you can pull the images. +```bash + docker pull lutraconsulting/merginmaps-backend-ee:2025.7.3 + docker pull lutraconsulting/merginmaps-frontend-ee:2025.7.3 +``` +*Please note the correct/latest version you want to pull from the available [releases](https://github.com/MerginMaps/server/releases)* \ No newline at end of file diff --git a/src/server/install/ee/login_IAM.jpg b/src/server/install/ee/login_IAM.jpg deleted file mode 100644 index 52868861..00000000 Binary files a/src/server/install/ee/login_IAM.jpg and /dev/null differ diff --git a/src/server/install/ee/login_IAM.xcf b/src/server/install/ee/login_IAM.xcf deleted file mode 100644 index 8850b71d..00000000 Binary files a/src/server/install/ee/login_IAM.xcf and /dev/null differ diff --git a/src/server/install/ee/root_login.jpg b/src/server/install/ee/root_login.jpg deleted file mode 100644 index 57ec8515..00000000 Binary files a/src/server/install/ee/root_login.jpg and /dev/null differ diff --git a/src/server/install/ee/root_login.xcf b/src/server/install/ee/root_login.xcf deleted file mode 100644 index d11e3e44..00000000 Binary files a/src/server/install/ee/root_login.xcf and /dev/null differ diff --git a/src/server/install/index.md b/src/server/install/index.md index afb4b328..c0696b44 100644 --- a/src/server/install/index.md +++ b/src/server/install/index.md @@ -52,7 +52,7 @@ 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 . +The enhanced features are only available on specific Docker images stored on Lutra Consulting's private Docker Hub repository. To get access, you need your contract and licence from our . Afterwards, you can follow [this guide](./ee/) to retrieve your images.