Install Onegini Extension Engine
To install the Onegini Extension Engine please follow the steps described.
Download the Docker image
The Onegini Extension Engine is delivered as a Docker image. There are two ways to receive a Docker image:
Docker Index
The first and preferred way is to use the Onegini index. This is the central container repository of Onegini. To download the containers you first need to login with the Docker client using your login credentials.
docker login https://release.onegini.com
After you logged in on the Onegini Index you can pull the latest images.
docker pull release.onegini.com/onegini/extension-engine:<version>
NOTE: If you did not receive any login credentials, please contact Onegini support.
Import from tar
The second way is to import the image from a tarball. This options is mostly used when the docker host has no internet connection.
docker load < /path/to/extension-engine-<version>.tar
Show images
To verify that the docker images are loaded, use the docker images command.
docker images
Deploy application
The application can be deployed using docker-compose
. At least 512 MB of memory is required by the application, this should be assigned using the JAVA_OPTS
environment variable. Any port can be used to expose the apis, the default is 7876
.
Configuration
Please see the topic guides for configuration instructions.
Example docker-compose file
version: "2"
services:
extension-engine:
image: release.onegini.com/onegini/extension-engine:latest
environment:
- JAVA_OPTS=-Xmx512m -Xms512m
- EXTENSION_ENGINE_DATABASE_TYPE=mysql
- EXTENSION_ENGINE_DATABASE_URL=jdbc:mysql://database:3306/extension-engine?autoReconnect=true
- EXTENSION_ENGINE_DATABASE_USERNAME=onegini
- EXTENSION_ENGINE_DATABASE_PASSWORD=onegini
- EXTENSION_ENGINE_DATABASE_ENCRYPTION_PASSWORD=remdtxjk8kv8lrb7b9vxlhacfqtqslvzu6h59j6c
- EXTENSION_ENGINE_BASIC_AUTHENTICATION_USER=xe-basic-auth-user
- EXTENSION_ENGINE_BASIC_AUTHENTICATION_PASSWORD=E6D8wNcTEeSrgENw9k6Y
restart: always
user: onegini
ports:
- 7876:7876
networks:
- xe
# For local development and testing only
database:
image: mariadb:latest
mem_limit: 512mb
restart: always
environment:
# Service Discovery
- SERVICE_IGNORE=true
# MariaDB
- MYSQL_ROOT_PASSWORD=root
- MYSQL_DATABASE=extension-engine
- MYSQL_USER=onegini
- MYSQL_PASSWORD=onegini
volumes:
- /opt/onegini/xe/database:/var/lib/mysql
networks:
- xe
networks:
xe:
driver: bridge
ipam:
driver: default
config:
- subnet: 192.168.0.0/24