EDIT

      <!-- Build Docker image -->

      <plugin>

        <groupId>io.fabric8</groupId>

        <artifactId>docker-maven-plugin</artifactId>

        <version>0.28.0</version>

        <configuration>

           <images>

             <image>

               <!-- docker hub does not allow dots in organizations, so the name is

                    just 'cybertaxonomy', this MUST NOT BE CHANGED!!!!  -->

               <name>cybertaxonomy/${project.artifactId}:${project.version}</name>

               <build>

                 <!-- use a Dockerfile in the directory src/main/docker/production -->

                 <dockerFileDir>production</dockerFileDir>

                 <!-- fabric8-maven-plugin filters given Dockerfile with Maven properties -->

                 <!-- For example, the default <filter>${*}</filter> parse Maven properties 

                     in the format that we know. If you specify a single character for 

                     <filter> then this delimiter is taken for both, the start and the end. 

                     E.g a <filter>@</filter> triggers on parameters in the format @…​@, -->

                 <filter>@</filter>

                 <assembly>

                    <descriptorRef>artifact</descriptorRef>

                    <!--

                         1. The maven plugin copies the jar to the artifacts assembly locaton at:

                            ./target/docker/eu.etaxonomy/cdm-server/${project.version}/build/maven/cdm-server-${project.version}.jar

                         2. a tar is being created at target/docker/eu.etaxonomy/cdm-server/${project.version}/tmp/docker-build.tar 

                            which contains all files located in /target/docker/production and the artifacts. 

                            Artifacts are put into the folder maven/ inside the tar archive

                         3. The tar archive is passed to the docker daemon and is used as working directory for the build 

                     -->

                  </assembly>

               </build>

               <run>

                 <ports>8080:8080</ports>

                 <!-- TODO configure if needed, see src/main/docker/production/README for examples -->

               </run>

             </image>

           </images>

        </configuration>

        <!-- Connect start/stop to pre- and

             post-integration-test phase, respectively if you want to start

             your docker containers during integration tests -->

        <executions>

          <execution>

             <id>start</id>

             <phase>pre-integration-test</phase>

             <goals>

               <!-- "build" should be used to create the images with the

                    artifact -->

               <goal>build</goal>

               <goal>start</goal>

             </goals>

          </execution>

          <execution>

             <id>stop</id>

             <phase>post-integration-test</phase>

             <goals>

               <goal>stop</goal>

            </goals>

          </execution>

        </executions>

      </plugin>

FROM anapsix/alpine-java:8

# paths of files and directories will be interpreted as relative to the source of the context of the build.

### ADD directive for the maven docker plugin

# 1. The maven plugin copies the jar to the artifacts assembly locaton at:

#    ./target/docker/eu.etaxonomy/cdm-server/${project.version}/build/maven/cdm-server-${project.version}.jar

# 2. a tar is being created at target/docker/eu.etaxonomy/cdm-server/${project.version}/tmp/docker-build.tar 

#    which contains all files located in /target/docker/production and the artifacts. 

#    Artifacts are put into the folder maven/ inside the tar archive

# 3. The tar archive is passed to the dockerdaemon and is used as working directory for the build

#ADD target/docker/@project.groupId@/@project.artifactId@/@project.version@/build/maven/@project.build.finalName@.jar /root/cdm-server.jar

ADD maven/@project.artifactId@-@project.version@.jar /root/cdm-server.jar

ARG CDMSERVER_PORT=8080

ARG HEAP_SIZE=1024M

ARG LOGDIR="/log/cdmserver"

ENV CDM_HOME=/data

ENV NAME=cdmserver

ENV DESC="CDM Server"

# ENV CDMSERVER_SHUTDOWN=30

ENV CPU_CORES=1

ENV DATASOURCES=$CDM_HOME/.cdmLibrary/datasources.xml

# java options which can be overwritten

ENV JAVA_OPTIONS="-Dspring.profiles.active=remoting"

# fixed java options which must not be overwritten

ARG JAVA_OPTS="-Xmx$HEAP_SIZE \

    -XX:+UseG1GC -XX:ParallelGCThreads=$CPU_CORES -XX:ConcGCThreads=$CPU_CORES  \

    -Duser.home=$CDM_HOME $JAVA_OPTIONS"

ARG SERVER_ARGS="-forceSchemaUpdate -jmx"

ENV CDMSERVER_ARGS="-httpPort=$CDMSERVER_PORT -logdir=$LOGDIR -datasources $DATASOURCES"

EXPOSE $CDMSERVER_PORT

CMD java $JAVA_OPTS $JAVA_OPTIONS  -jar /root/cdm-server.jar $SERVER_ARGS $CDMSERVER_ARGS

FROM anapsix/alpine-java:8

# paths of files and directories will be interpreted as relative to the source of the context of the build.

### ADD directive for building the image manually using the docker command

ADD target/cdm-server-*.jar /root/cdm-server.jar

ARG CDMSERVER_PORT=8080

ARG HEAP_SIZE=1024M

ARG LOGDIR="/log/cdmserver"

ENV CDM_HOME=/data

ENV NAME=cdmserver

ENV DESC="CDM Server"

# ENV CDMSERVER_SHUTDOWN=30

ENV CPU_CORES=1

ENV DATASOURCES=$CDM_HOME/.cdmLibrary/datasources.xml

# java options which can be overwritten

ENV JAVA_OPTIONS="-Dspring.profiles.active=remoting"

# fixed java options which must not be overwritten

ARG JAVA_OPTS="-Xmx$HEAP_SIZE \

    -XX:+UseG1GC -XX:ParallelGCThreads=$CPU_CORES -XX:ConcGCThreads=$CPU_CORES  \

    -Duser.home=$CDM_HOME $JAVA_OPTIONS"

ARG SERVER_ARGS="-forceSchemaUpdate -jmx"

ENV CDMSERVER_ARGS="-httpPort=$CDMSERVER_PORT -logdir=$LOGDIR -datasources $DATASOURCES"

EXPOSE $CDMSERVER_PORT

CMD java $JAVA_OPTS $JAVA_OPTIONS  -jar /root/cdm-server.jar $SERVER_ARGS $CDMSERVER_ARGS

# CDM Server Docker Container

## Requirements

Install the latest version of Docker (you will need at least version 18.09.0, earlier versions might work also but are untested). Instructions on the installation process for various operation systems are found at https://docs.docker.com/install/

NOTE: On linux you may want to add your user to the docker group (https://docs.docker.com/install/linux/linux-postinstall/):

    sudo usermod -aG docker $USER

Log out and in afterwards to update the group membership.

If you plan to use docker-compose install it now: https://docs.docker.com/compose/install/

## Build docker container manually

## with the `docker` command

In the root of the cdm-server project execute:

    docker build --tag=cybertaxonomy/cdm-server:${version} -f src/main/docker/${project.version}/Dockerfile.dev ./

e.g.

    docker build --tag="cybertaxonomy/cdm-server:5.5.0-SNAPSHOT" -f src/main/docker/production/Dockerfile.dev ./

### with maven

    mvn docker:build

## Running the image 

### with docker

Running the cdmserver docker container as developer

Expects the datasource file as `datasources-cdm-server.xml` (see cdm-server-dev.env)

NOTE: If you are using **symlinks** in the `.cdmLibrary` these must be use path outside of this folder. Otherwise they mioght not be valid inside the container

    docker run -dit --restart unless-stopped \

        -p 8080:8080 \

        -h cdmserver-dev \

        --env-file=src/main/docker/production/cdm-server-dev.env \

        --mount type=bind,source=$HOME/.cdmLibrary,destination=/data/.cdmLibrary \

        --mount type=bind,source=$(pwd)/,destination=/var/log/cdmserver \

        cybertaxonomy.eu/cdm-server:${version}

### with docker-compose

### with maven

    ...

## Shell access to the running docker container

1. find the `CONTAINER ID` or container name

    docker ps

1. Start the shell inside the container

    docker exec -it $CONAINER_ID|$CONTAINER_NAME /bin/bash

-i : --intertactive, -t: --tty

##########################################################################

# env_file for docker or docker compose 

#

# see 

#    - https://docs.docker.com/compose/compose-file/#env_file

# -----------------------------------------------------------------------

# The commented ENV variables below show the default values as example!

##########################################################################

###

# The name of the docker container in RUN mode

#NAME=cdmserver

###

# Description of the docker container in RUN mode

#DESC="CDM Server"

###

# The home directory for the cdm-server process. At this location the cdm-server will 

# create the .cdmLibrary folder which will contain per instance configurations,

# lucene full text index, and other resources

#CDM_HOME=/data

###

# The location of the datasources.xml file to be used by the cdm-server. The datasource.xml file 

# contains the spring bean definitions of the datasources to be loaded by the server.

# NOTE: variable expansion does not work in this file, so the $CDM_HOME can not be used here.

DATASOURCES=/data/.cdmLibrary/datasources-cdm-server.xml

###

# The numberof cpu cores available on the host machine, this value is 

# being used to configure effective jvm garbage collection

#CPU_CORES=1

###

# Alternative options for the JVM

# You MUST NOT use any of: -Xmx, XX:+UseG1GC -XX:ParallelGCThreads, -XX:ConcGCThreads=, -Duser.home

# since these are managed internally in the container

#JAVA_OPTIONS=-Dspring.profiles.active=remoting

###

# Alternative arguments for the cdm-server.

# You may only want to use the following options to avoid conflicts with the once managed in the container:

#

# -forceSchemaUpdate                      USE THIS OPTION WITH CARE! Outdated cdm database schema versions will 

#                                         be forcably updated to the version of the cdm-server. This option is only intended to be

#                                         used for development purposes.

#

# -jmx                                    Start the server with the Jetty MBeans in JMX Management mode.

#                                         For testing you can use the following jvm options:

#                                         -Dcom.sun.management.jmxremote.ssl=false

#                                         -Dcom.sun.management.jmxremote.authenticate=false

#                                         -Dcom.sun.management.jmxremote.port=9999

#CDMSERVER_ARGS=-forceSchemaUpdate -jmx

##########################################################################

# env_file for docker or docker compose 

#

# see 

#    - https://docs.docker.com/compose/compose-file/#env_file

# -----------------------------------------------------------------------

# The commented ENV variables below show the default values as example!

##########################################################################

###

# The name of the docker container in RUN mode

#NAME=cdmserver

###

# Description of the docker container in RUN mode

#DESC="CDM Server"

###

# The home directory for the cdm-server process. At this location the cdm-server will 

# create the .cdmLibrary folder which will contain per instance configurations,

# lucene full text index, and other resources

#CDM_HOME=/data

###

# The location of the datasources.xml file to be used by the cdm-server. The datasource.xml file 

# contains the spring bean definitions of the datasources to be loaded by the server.

# NOTE: variable expansion does not work in this file, so the $CDM_HOME can not be used here.

#DATASOURCES=/data/.cdmLibrary/datasources.xml

###

# The numberof cpu cores available on the host machine, this value is 

# being used to configure effective jvm garbage collection

#CPU_CORES=1

###

# Alternative options for the JVM

# You MUST NOT use any of: -Xmx, XX:+UseG1GC -XX:ParallelGCThreads, -XX:ConcGCThreads=, -Duser.home

# since these are managed internally in the container

#JAVA_OPTIONS=-Dspring.profiles.active=remoting

###

# Alternative arguments for the cdm-server.

# You may only want to use the following options to avoid conflicts with the once managed in the container:

#

# -forceSchemaUpdate                      USE THIS OPTION WITH CARE! Outdated cdm database schema versions will 

#                                         be forcably updated to the version of the cdm-server. This option is only intended to be

#                                         used for development purposes.

#

# -jmx                                    Start the server with the Jetty MBeans in JMX Management mode.

#                                         For testing you can use the following jvm options:

#                                         -Dcom.sun.management.jmxremote.ssl=false

#                                         -Dcom.sun.management.jmxremote.authenticate=false

#                                         -Dcom.sun.management.jmxremote.port=9999

#CDMSERVER_ARGS=-forceSchemaUpdate -jmx

version: '3'

services: 

    cdmserver:

        ports:

        - "8080:8080" 

        env_file:

        - ./cdm-server.env

        volumes:

        # recommended settings for development

        - type: bind

          source: ~/ # user-home as a cdm-server-home => use the .cdmLibrary in user home

          target: /data

        - type: bind

          source: ./ # log directly into the working directory

          target: /log/cdmserver

version: '3'

services: 

    cdmserver:

        ports:

        - "8080:8080" 

        env_file:

        - ./cdm-server.env

        restart: unless-stopped 

        volumes:

        # recommended settings for production

        - type: bind

          source: /var/lib/cdmserver

          target: /data

        - type: bind

          source: /var/log/cdmserver

          target: /log/cdmserver

        # recommended settings for development

        #- type: bind

        #  source: ~/ # user-home as a cdm-server-home => use the .cdmLibrary in user home

        #  target: /data

        #- type: bind

        #  source: ./ # log directly into the working directory

        #  target: /log/cdmserver