Docker Setup Guide

This document describes the docker setup for Ambience 2026 software.

Docker is a software platform that allows user to build, test, and deploy applications quickly. Docker packages software into standardised units called containers that have everything the software needs to run including libraries, system tools, code and runtime.

Refer to the following websites for more information:

Pre-requisites

The following are the pre-requisites for using the docker:

  • Java 17 or above (including OpenJDK)

  • MongoDB 4.4.x or above (including MongoDB Atlas)

  • Ambience Software Suite

Requirements:

Install Docker

Docker allows you to separate your applications from your infrastructure so you can deliver software quickly. With Docker, you can manage your infrastructure in the same ways you manage your applications.

  1. Go to https://docs.docker.com/get-started/get-docker/ website.

  2. In the webpage, select the Docker for the desired platform.

  3. Note the requirements for the Docker and follow the instructions in the webpage.

  4. Go to https://github.com/ambience-cloud/elixir-ambience website.

  5. Download the files in the Git Hub page.

    Note the requirements listed in the page. Edits needs to be done on the scripts to adapt to the Windows environment.

Setup Docker

To setup the Docker, perform the following:

  1. Go to https://github.com/ambience-cloud/elixir-ambience website.

  2. Download the files in the Git Hub page.

    Note the requirements listed in the page. Edits needs to be done on the scripts to adapt to the Windows environment.

  3. Read the “README.md” file and setup the Docker according.

Run Docker

Run the Docker Compose to start a MongoDB database and Ambience using the following command:

./run-ambience-compose.sh

This will pull the latest Ambience and MongoDB image at “elixirtech/elixir-ambience” docker repository. MongoDB and Ambience are starting in the order as shown below:

latest: Pulling from elixirtech/elixir-ambience

Digest:
sha256:b6bfd3b320cedc18588e028ad65dd080b6f281725e78cde5d6aabe1cede4ec54

Status: Image is up to date for elixirtech/elixir-ambience:latest

docker.io/elixirtech/elixir-ambience:latest

[+] Running 2/2

⠿ Container elixir-mongo Started

⠿ Container elixir-ambience Started

Once the service is started, you can browse to the URL as "http://localhost:1740".

Note:

  • The Docker compose configuration file is “docker-compose.yaml”. It is configured to run a MongoDB database and Ambience containers. Remove MongoDB configuration if MongoDB already is running in the host.

  • Ambience configuration parameters for Ambience is in a hidden file “.env”. The parameters as the following:

mongourl="mongodb://mongo:27017"
externalhost="localhost"
externalport="1740"
externalprotocol="http:"

You can configure the default MongoDB URL, external host, port and http protocol. The external port used for the Docker’s MongoDB is 28017. IF you have a port conflict with any MongoDB running the host, you may change the MongoDB port in the “docker-compose.yaml” as:

mongo:
  ...
  ports:
    - 127.0.0.1:[change port from 20817]:27017

You can use external tool, such as “mongosh” to connect from the host to MongoDB container using the 29017 port.

Useful Docker Compose Commands and Scripts

—————————————————————- Docker Command Description ———————————- —————————– docker compose ps To list the service as

docker compose stop Stop Docker compose

docker compose rm Remove containers

docker compose restart Restart Ambience container elixir-ambience
—————————————————————-

Install Dependencies – Java, MongoDB

Install Java 17 You need to download and install any Java 17 (including Open JDK) or higher for Ambience. Install MongoDB MongoDB is a document database with the scalability and flexibility that you want with the querying and indexing that you need. It uses JSON-like documents with schema. Below are the steps to install MongoDB:

  1. Go to https://www.mongodb.com/download-center/community website.

  2. In the webpage, select MongoDB Community Server and select the following:

    • MongoDB 4.4.x or above (latest release is recommended)

    • Desired OS

    • Desired package

    Ambience also supports MongoDB Atlas.

  3. Click on the “Download” button.

  4. Installing the package:

    a. For MSI package, use the following steps:

    i.  Go to the directory where you downloaded the MongoDB installer
    (*.msi* file). By default, this is your downloads directory.

ii. Double click on the *.msi* file and follow the instructions in the
    installer wizard.

    b. For ZIP package, use the following steps:

    i.  Extract the zip file into the desired location.

ii. Create a folder "data/db" in the root directory of the location.
    This directory is required to save the database records.

    You may be prompted to install MongoDB Compass. It is an optional application.

  5. To run MongoDB:

    • From Windows Explorer/File Explorer, go to the “../MongoDB\Server/4.x/bin/” directory and double-click on mongod.exe.

    Depending on the OS, a command window will appear and may close after a few seconds.

    • For terminal window or command prompt for Windows, navigate to the “../MongoDB\Server/4.x/bin/” directory and execute the command “mongod.exe”.

    The MongoDB server runs at the default port 27017. For further details and advice on MongoDB installation, please refer to the MongoDB website.

Install Ambience

Contact our representatives for the Ambience suite. The Ambience comes in a form of a zip file. By default, the Ambience comes with a licence for a minimal set of modules that allows the administrator to log in and perform the basic setup. To acquire a larger set of modules, you will need to a new licence. To install Ambience, extract the zip file to the desired location.

Next: Client Guide (Java)