Local deployment of Marionette

The copy of this document you can find in the GitLab using this link:
https://gitlab.tunex.io/testdrive/configurator/-/tree/local-deployment/docs/local-deployment

Prerequisites

git
docker
node.js lts version
mkcert command line tool (see "Valuable resources" section)

Clone project from GitLab

Open Marionette configurator prepared for local deployment using the link.

Using the Clone button (see image below) copy HTTPS or SSH url to be used in a git clone command.

Run the clone command:

git clone --branch local-deployment https://gitlab.tunex.io/testdrive/configurator.git marionette

Move to the project's root folder

cd marionette

Prepare Tool command line utility

Run the commands below sequentially:

cd tool
npm install
cd ..
./m

You should receive:

Create SSL certificates in the secrets folder

cd config
mkdir secrets
cd secrets
openssl genrsa -out key.pem 2048 && openssl rsa -in key.pem -outform PEM -pubout -out public.pem

You may get something like:

Two files: key.pem and public.pem will be created in the secrets folder.

Return to the "marionette" folder

cd ../..

https on localhost

Generate SSL certificates

Init local Certificate Authority

The command bellow needs to be execute minimum once per a computer

mkcert -install

Create SSL certificates

cd config
mkdir local-certs
cd local-certs
mkcert -cert-file local-cert.pem -key-file local-key.pem "marionette.localhost" "*.marionette.localhost"
ls -la

Two files will be created: local-cert.pem local-key.pem

Check parameters for Configurator

File: global/config.yaml

base_url: marionette.localhost
localhost_run: true
loginCaptcha: false
components.traefik.ssl.enabled: true

Render config

# Return to the "marionette" folder if you not there
cd ../..

# execute render-config
./m render-config

Start services

docker-compose pull

There should not be errors like on the image below:

docker-compose up -d db db-bridge nats traefik

docker-compose up -d

Check the application

Open the URLs below and check that they are working

Front End: https://marionette.localhost/

Admin Panel: https://marionette.localhost/admin

Valuable resources

Details about mkcert tool and how to install it on different platforms.

If you need to generate SSL certificate for domain other than marionette.localhost, follow by the link.

Marionette Documentation