Installing OpenLM in Docker requires the following prerequisites:
- Docker & Docker Compose Plugin
- OpenLM License File
- OpenLM Docker Server Package
- An empty database (MariaDB, MySQL, SQL Server) * Optional
Install Docker & Docker Compose Plugin #
To install Docker please follow the official installation instructions:
- Docker → https://docs.docker.com/engine/install/
- Docker Compose Plugin → https://docs.docker.com/compose/install/linux/
Configure and Install OpenLM Server for Docker #
OpenLM Server for Docker can be installed using automated option, or manual installation.
The main difference between them is that the first option will install and configure the OpenLM docker instance with a provisioned MariaDB instance.
The second option requires a separate database instance and manual docker OpenLM provisioning.
Automated OpenLM Server for Docker Installation #
- Download OpenLM Server for Docker https://www.openlm.com/Server/Docker/Latest
curl -L -o olm.docker.tar.gz https://www.openlm.com/Server/Docker/Latest - Create a designated Directory for OpenLM Server for Docker installation files
mkdir olmdocker - Extract the OpenLM Server docker archive (olm.docker.tar.gz) to the newly created folder (olmdocker)
tar -xvf olm.docker.tar.gz -C olmdocker - Change the directory to the newly created folder olmdocker
cd olmdocker
Remove the windows new lines characters from the license file to prevent installation issues.sed -i "s/\r//g" path/to/your/licensefilename - Ensure the files have been extracted into the olmdocker folder by running the ls command
% ls -a
. docker-compose-mariadb.yml
.. docker-compose-server.yml
.env dockerfile-core
Readme.md install.sh
core update.sh - Run install.sh script with the OpenLM license file path
sudo ./install.sh -f path/to/your/licensefilename - Validate the installation by accessing Easyadmin User Interface by opening from browser http://<docker hostname>:5015/
Manual OpenLM Server for Docker Installation #
Before proceeding with the manual installation please ensure you have a database server with an empty database and all connection details available.
- Download OpenLM Server for Docker https://www.openlm.com/Server/Docker/Latest
curl -L -o olm.docker.tar.gz https://www.openlm.com/Server/Docker/Latest - Create a designated Directory for OpenLM Server for Docker installation files
mkdir olmdocker - Extract the OpenLM Server docker archive (olm.docker.tar.gz) to the newly created folder (olmdocker)
tar -xvf olm.docker.tar.gz -C olmdocker - Change the directory to the newly created folder olmdocker
cd olmdocker - Remove the windows new lines characters from the license file to prevent installation issues.
sed -i "s/\r//g" path/to/your/licensefilename - Ensure the files have been extracted into the olmdocker folder by running the ls command
% ls -a
. docker-compose-mariadb.yml
.. docker-compose-server.yml
.env dockerfile-core
Readme.md install.sh
core update.sh - Update .env file properties with the DB connection details and docker hostname.
MARIADB_ROOT_PASSWORD=toor
DB_USER=[user for the DB connection]
DB_PASSWORD=[password for the db connection]
DB_DATABASE=[DB name]
DB_TYPE=[DB type]
DB_SERVER=[DB Server address]
DB_PORT=[DB port]
SERVER_PORT=5015
SERVER_VERSION=22.12.26
MAC_ADDRESS=[MAC address from your license file]
DOCKER_HOSTNAME=[server hostname from your license file]Supported DB_TYPES: MariaDB, MySql, SqlServer_SQLServerAuth, SqlServer_WinAuth.
- Create the log folder for OpenLM Server
sudo mkdir -p /opt/openlm/server/log - Copy the license file into the core folder from olmdocker
sudo cp path/to/your/licensefilename core/license/licensefilename - Install the OpenLM Server container
docker-compose -f docker-compose-server.yml up --build -dalternatively
docker compose -f docker-compose-server.yml up --build -d - Validate the installation by accessing Easyadmin User Interface by opening from browser http://<docker hostname>:5015/
