Starting and Stopping Monolith Server

// Deploy and Run Monolith Containers
// Must be run in same directory as docker-compose.yml
docker compose up -d

// Remove Monolith containers
// ust be run in same directory as docker-compose.yml
docker compose down

These commands can be used together to conduct a "hard" restart of Monolith.

Various Docker Commands

// Show resource usage of docker containers
docker stats

// Show running containers
docker container ls -a

// Show downloaded container images
docker image ls -a

// Download fresh container image
docker pull [container-name]

// Restart container
docker container restart [container-name]

Docker CLI Reference

Additional Docker commands can be reviewed on Dockers official documentation pages:

https://docs.docker.com/engine/reference/run/

Docker Compose CLI Reference

Additional Docker compose commands can be reviewed on Docker's official documentations pages:

https://docs.docker.com/compose/reference/

On-Premises Package

Once you have purchased Monolith and are ready to deploy - you will be provided with a Monolith On-premises deployment package. This package will contain configuration files necessary to run the deployment.

Package Contents

The package will contain the following items:

• .env

  • This is an environment file that will contain variables that are injected into your Monolith deployment at run time. This is where your licensing information will be location along with other settings.

• docker-compose.yml

  • This is a Docker deployment configuration file. This file dictates how the various Monolith containers will be built and deployed.

  • This allows you to use a pre-defined configuration so that you don't need to build the Monolith Docker deployment from scratch.

• init folder

  • This contains additional configuration files needed for successful deployment.

Example

This is an environment variables file that is loaded into the Monolith Docker deployment at build/run time. These values determine various setup options and licensing information for your Monolith deployment.

The values are typically set for you when you purchase Monolith.

### Application Settings ###

### Mandatory Options ###

### Monolith License key
# Used to activate license

MONOLITH_LICENSE_KEY=
MONOLITH_LICENSE_TOKEN=

### API Token Secrets
# Used to generate secure access tokens and refresh tokens
# Set these to long, random alphanumeric strings

ACCESS_TOKEN_SECRET=
REFRESH_TOKEN_SECRET=


### Monolith Database Config

MONOLITH_DB_NAME=monolith
MONOLITH_DB_USER=monolith
MONOLITH_DB_PORT=3306
MONOLITH_DB_HOST=mysql
MONOLITH_DB_PASSWORD=

### Initial Monolith User - Only needed for initial setup

MONOLITH_ADMIN_FIRST_NAME=
MONOLITH_ADMIN_LAST_NAME=
MONOLITH_ADMIN_EMAIL=
MONOLITH_ADMIN_PASSWORD=

### Monolith Forms Settings

FORM_TENANT_NAME=
FORM_ORG_NAME=
FORM_TENANT_SLUG=
FORM_TENANT_EMAIL=

### OPTIONAL SETTINGS ###

### API Instance Total
# Set the number of API cluster instances to run
# default is 1 - which should be plenty for most deployments

#API_INSTANCE_COUNT=1

### File Service
# Choose the file service you wish to use
# Options are "S3" and "LOCAL"
# Defaults to "LOCAL" if not set
# S3 keys required if using S3 service

# FILE_SERVICE=S3
# FILE_SERVICE=LOCAL



### AWS S3 Config

# AWS_ENDPOINT={aws_endpoint}
# MONOLITH_FORMS_BUCKET={aws_bucket_name}
# MONOLITH_CLOUD_BUCKET={aws_bucket_name}
# S3_ACCESS_KEY={s3_access_key}
# S3_SECRET_KEY={s3_secret_key}

### SMTP settings
SMTP_HOST=
SMTP_PORT=
SMTP_USER=
SMTP_PASSWORD=

Values

MONOLITH_LICENSE_KEY

This is a license key that allows for your Monolith deployment to get licensing information from our online license server. Using this value ensures that your Monolith deployment always has up to date license info.

This key will be provided to you upon purchase.

MONOLITH_LICENSE_TOKEN

This is a signed token that contains licensing information for your Monolith purchase. This can be used to utilize cached license info without needed to query our licensing server for license info.

This is a good option for Monolith deployments that exist in air-gapped environments.

If this value is provided, Monolith will use this instead of the license key value.

ACCESS_TOKEN_SECRET

This should be a long alphanumeric string. This value is used for various cryptographic operations related to access tokens, encryption, and session management.

REFRESH_TOKEN_SECRET

This should be a long alphanumeric string. This value is used for various cryptographic operations related to access tokens, encryption, and session management.

MONOLITH_DB_NAME

This is the name of the MySQL schema that the Monolith API server should connect to.

MONOLITH_DB_HOST

This is the domain or IP address of the MySQL database host that the Monolith API server should connect to.

MONOLITH_DB_USER

This is the MySQL user name that should be used for database connections.

MONOLITH_DB_PORT

The port that should be used for database connections. The default MySQL port is 3306.

MONOLITH_DB_PASSWORD

MySQL password used to establish database connections.

MONOLITH_ADMIN_FIRST_NAME

First name of initial Monolith user. Only required for first time setup/deployment.

MONOLITH_ADMIN_LAST_NAME

Last name of initial Monolith user. Only required for first time setup/deployment.

MONOLITH_ADMIN_EMAIL

Email of initial Monolith user. Only required for first time setup/deployment.

MONOLITH_ADMIN_PASSWORD

Password of initial Monolith user - this will be used for firs time login to Monolith. Only required for first time setup/deployment.

FORM_TENANT_NAME

Initial tenant name for your Relay deployment. Only required for first time setup/deployment.

FORM_ORG_NAME

Organization name for your Relay deployment. Only required for first time setup/deployment.

FORM_TENANT_SLUG

URL slug for your Relay deployment. Only required for first time setup/deployment.

my-forensic-company

FORM_TENANT_EMAIL

Initial tenant email for your Relay deployment. Only required for first time setup/deployment.

API_INSTANCE_COUNT

The Monolith API server runs in "cluster" mode. This allows multiple instances to run at the same time, which increases scalability. This value defaults to 1 and is disabled by default. You will likely not need to use this value, but contact support if you think this is needed.

FILE_SERVICE

This value determines whether Monolith will use a local file system or Amazon S3 to store Monolith files. Allowed values are "S3" or "Local". The default value is "Local". If you set this to "S3", you will also need to set the S3 access key values.

AWS_ENDPOINT

This value configures Monolith to use the correct AWS region with your S3 bucket.

MONOLITH_FORMS_BUCKET

The S3 bucket where you would like to store files uploaded to Relay.

MONOLITH_CLOUD_BUCKET

The S3 bucket where you would like to store files uploaded to Monolith.

S3_ACCESS_KEY

AWS access key to use S3 APIs for file storage.

S3_SECRET_KEY

AWS secret key to use S3 APIs for file storage.

SMTP_HOST

Email host domain to enable email capabilities in Monolith.

SMTP_PORT

Email port to enable email capabilities in Monolith. This value is typically 587.

SMTP_USER

User value to enable email capabilities in Monolith. May not be required if you are using an SMTP relay.

SMTP_PASSWORD

User password to enable email capabilities in Monolith. May not be required if using an SMTP relay.

Windows

To Install Docker on Windows, you need to install Docker Desktop for Windows. This installer can be downloaded from here:

https://www.docker.com/products/docker-desktop/

WSL

To deploy Monolith on Windows, you will need to install the WSL package for Windows. This allows Windows to run Linux containers. During the Docker Desktop install, Docker typically prompts you to install this. If not, here is a direct link to download and install WSL:

https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi

MacOS

To Install Docker on MacOS, you need to install Docker Desktop for MacOS. This installer can be downloaded from here:

https://www.docker.com/products/docker-desktop/

Linux

To install Docker on a Linux OS, refer to the following Docker documentation for Linux installations:

https://docs.docker.com/engine/install/ubuntu/

Default Deployment

Deploying Monolith with the default configuration is a simple matter.

1. Install Docker - Instructions

2. Pick a location to store your on-premises package files.

3. Open a command terminal.

4. Navigate to the location of your Monolith On-premises package files.

   • This is the folder that contains the .env and docker-compose.yml files.

5. Run the following command to download, deploy, and run the Monolith containers referenced in the docker-compose.yml file:

   • docker compose up -d

6. This will download the Monolith container images which may take a few minutes.

7. Once downloaded, the containers will launch and build the initial Monolith system.

8. You can then navigate to Monolith in a web browser using the IP address of the host system running Monolith:

   • https://{host_server_ip}

To remove the docker containers, you can use the following command:

docker compose down

Example

File Example

This file is used to define the deployment options for the various Docker containers that make up the Monolith on-premises deployment.

Unless you require an advanced deployment, you will not need to modify this file.

services:
  monolith-api:
    container_name: monolith-api
    image: monolithforensics/monolith-api:latest
    restart: always
    volumes:
      - ./data/logs:/usr/src/app/data/logs
      - ./data/Monolith:/usr/src/app/data/Monolith
      - ./data/Monolith-forms:/usr/src/app/data/Monolith-forms
    ports:
      - "3001:3001"
    env_file:
      - .env
    mem_limit: 512m

  monolith-forms:
    container_name: monolith-forms
    image: monolithforensics/monolith-forms:on-prem
    restart: always
    volumes:
      - ./data/logs:/usr/src/app/data/logs
    ports:
      - "3003:3003"
    mem_limit: 150m

  monolith:
    container_name: monolith
    image: monolithforensics/monolith:on-prem
    restart: always
    volumes:
      - ./data/logs:/usr/src/app/data/logs
    ports:
      - "3005:3005"
    mem_limit: 150m

  mysql:
    container_name: mysql2
    image: mysql:8.0.16
    command: --default-authentication-plugin=mysql_native_password --sql_mode=""
    security_opt:
      - seccomp:unconfined
    restart: always
    ports:
     - "3307:3306"
    environment:
      MYSQL_ROOT_PASSWORD: ${MONOLITH_DB_PASSWORD}
      MYSQL_USER: ${MONOLITH_DB_USER}
      MYSQL_PASSWORD: ${MONOLITH_DB_PASSWORD}
      MYSQL_DATABASE: ${MONOLITH_DB_NAME}
    volumes:
      - ./data/mysql:/var/lib/mysql
      - ./init:/docker-entrypoint-initdb.d
    mem_limit: 512m

  nginx:
    container_name: nginx
    image: monolithforensics/nginx:latest
    restart: always
    ports:
      - "80:80"
      - "443:443"
    volumes:
     - ./data/logs/nginx:/var/log/nginx/
    # - /etc/nginx:/etc/nginx
    # - /etc/letsencrypt:/etc/letsencrypt/

  watchtower:
    container_name: watchtower
    image: containrrr/watchtower:latest
    restart: always
    environment:
     - WATCHTOWER_CLEANUP=true
    command: --interval 30
    volumes:
     - /var/run/docker.sock:/var/run/docker.sock
    mem_limit: 512m

How this file works

This file is used with the following commands to build, re-build, and remove the containers that run Monolith.

// Deploy Monolith
docker compose up -d

// Remove All Monolith Containers
docker compose down