Skip to content

Installation and setup

Jump to bottom Edit New page
Marco Descher edited this page Apr 19, 2018 · 17 revisions

WORK IN PROGRESS - DO NOT REFER TO THIS PAGE - DOCUMENTATION BOUND FOR ES 1.6

This page describes the installation and setup of Elexis-Server (ES). Where the setup is completed, on the state that ES is connected to an Elexis database.

Requirements

Elexis-Server (ES) requires an Elexis-Database connection to provide its functionality as currently is not able to set-up an Elexis-Database itself.

To provide such a database an Elexis installation with the following additional plugins is required:

  • Artikelstamm
  • Omnivore
  • Base CH
  • LaborTarif
  • Physioleistung

ES1.6 requires Elexis 3.6 for correct functionality.

Installation

ES is available both as download and as docker image. In development we use several development streams. master is always the bleeding edge, which might not be appropriate for you. We recommend you to stick to the highest 1.x version available mentioned.

Installation via Download

You may download the ES products from http://download.elexis.info/elexis-server/, where you have to select your required development stream and the product directory contained.

Installation via Docker

Docker is a software that allows for the distribution of software in form of containers. This is very much like the containers you know in shipping. Docker is available for all major platforms, we however recommend and document the usage on a Linux system. If setting up a linux system with docker is too complicated for you, you might find a viable solution using a synology device.

Plain docker usage

  1. Start the docker image in foreground docker run -p 8380:8380 -p 8480:8480 -p 7234:7234 medevit/elexis-server (add -e DEMO_MODE='true' to enable demo mode)
  2. Set the database connection using a POST call

Usage on Synology devices

Synology features a number of network appliances. This documentation is based on a Synology DS916+ with operating system DSM6.1.5.

Prepare the required volume directory

We have to provide a separate volume to the ES container image, to host the ES home directory. If we don't do this, the ES home directory will be bound to the created container image, and not be available for subsequent updates of the container image.

  1. Using File Station generate a directory elexis in your users home directory under homes
  2. Adjust the permissions on this directory, such that the following parts will work Docker target home directory permissions

Setup docker and an elexis-server container

  1. Install the Docker package via the package center

  2. Start the docker package by clicking on it in the main-screen

  3. Download the newest medevit/elexis-server docker image and select the latest tag. The resulting download will take some time. Download medevit/elexis-server image

  4. The tab Image will now contain an image called medevit/elexis-server:latest

  5. Select this image, and use the Launch button to create a new container out of the image

  6. Name the new image elexis-server and subsequently edit Advanced Settings Create Docker Container Start

  7. Switch to Volume and add the required volume directory Docker volume bind

  8. Switch to Port Settings and add set the local port to static values. ⚠️ Binding port 7234 effectively opens the ES OSGI console for access, you might consider not to include this port. Docker container static port values

  9. If you want to start this system as a demo system go to Environment and add the variable DEMO_MODE with value true. This will effectively override the current settings and activate the demo system. If you remove this variable later on the system will switch back to its original mode.

Setup

Configuring the database connection

If ES was started in demo-mode, the database configuration is already set to the database that was downloaded into the ES home directory during startup.

If you started ES in non-demo-mode, you have to manually configure the database connection. This can be done by either providing a file elexis-connection.xml in the ES home-directory, or by posting it to the Elexis REST API (the first POST call - effectively binding ES to a database, is not security protected).

The following code snippet shows a sample elexis-connection.xml file.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<dbConnection hostName="mysqlHostName" port="3306"
	databaseName="elexisDatabase" connectionString="jdbc:mysql://mysqlHostName:3306/elexisDatabase"
	username="elexis" password="elexis">
		<rdbmsType>MYSQL</rdbmsType>
</dbConnection>

⚠️ localhost as accessible for the host, is not accessible to a docker container. In order to connect to the database system you have to provide a "real" ip address or hostname

After configuring the elexis-connection.xml to match your setting, you may post it to the ES using e.g. curl with

curl -X POST --header "Content-Type:application/xml;charset=UTF-8" -d @elexis-connection.xml http://localhost:8380/services/elexis/connector/v1/connection

this call might take a while to return (due to the required services startups). If the connection to the database was successful, the call will answer db pool initialization success.

Add a custom footer

Table of Contents

Clone this wiki locally