You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Before running through this guide, please make sure docker has been installed on the machine.

Login to Docker Hub

In order to be able to pull Docker images, we need login to the official Docker Hub first by simply using the following command:

docker login

 

Pull DMS Docker images

DMS components have been packaged as three docker images:

  1. practiceinsight/dms_postgresql
  2. practiceinsight/dms_elasticsearch
  3. practiceinsight/dms_nuxeo_suite

To pull these images, please simply execute the commands below:

docker pull practiceinsight/dms_postgresql
docker pull practiceinsight/dms_elasticsearch
docker pull practiceinsight/dms_nuxeo_suite:1.9.0

 

Run DMS Docker containers

Common rules for all containers

  1. Be sure, that user that launches docker container has write permissions on the mounting folders.
  2. On Windows mounting folders must be located in C:/Users, on Mac OS X - in /Users 
  3. When you are starting the container on Windows, folder must be mounted that way (two slashes are needed for the windows path): 

    -v //c/users/:/path_in_container
  4. If you operate docker on Windows with Docker Quickstart Terminal, then execution of the docker exec commands on windows must be done in the docker machine command line. if the docker machine is called "default", then you can get access to it with:

    docker-machine ssh default

    If you operate docker with PowerShell then this step is unnecessary.

Run DMS PostgreSQL container on Windows or Mac OS X

Requirements to run:

  1. PostgreSQL backup folder must be mounted.
  2. Port 5432 must be exposed.

Example command:

docker run -p 5432:5432 -v /backup_folder_on_host :/backup --name postgres -d practiceinsight/dms_postgresql_winmac

If you have an running PostgreSQL database which needs to be migrated to the PostgreSQL container, the best way is to export the data first and then import to the PostgreSQL database running with the Docker container. You can mount the existing folder with PostgreSQL 9.3 database, but be sure to have backup, because the owner and permissions of these files will be changed and the data can be changed.

To export the original Nuxeo PostgreSQL database, please use the following commands (please change parameters as needed):

pg_dump --host localhost --port 5432 --username nuxeo --format custom --file "nuxeo-postgresql-db-20150916.bak" nuxeo

This command will ask for the password of the Nuxeo database, so please prepare that in advance.

After that, we need to copy the backup file to the backup folder on host machine:

Then you need to execute the next docker command:

docker exec -it postgres pg_restore --dbname=postgresql://nuxeo:nuxeop@127.0.0.1:5432/nuxeo /backup/nuxeo-postgresql-db-20150916.bak

To backup the database from the container, you need to execute:

docker exec -it postgres pg_dump --dbname=postgresql://nuxeo:nuxeop@127.0.0.1:5432/nuxeo -Fc --file "/backup/nuxeo-postgresql.bak"

There is also automatic backup script that is disabled by default, to enable it you need to execute the next command:

docker exec -it postgres chmod +x /etc/services/backup/run

After script enabling it will start to make the backup copies of the nuxeo database to the backup folder every hour.

If you want to change the parameters if the backup script (such as backup format, password, time delay between backups), you can easily do it with the next command:

docker exec -it postgres vim /etc/services/backup/run

To stop the automatic backups you just need to:

docker exec -it postgres chmod -x /etc/services/backup/run

Run DMS PostgreSQL container on Linux

DMS Postgresql for Linux is a container that is similar to a WinMac one, but all the data files of the postgresql are located in the folder of host machine.

 

Run DMS ElasticSearch container

Requirements to run:

  1. ElasticSearch data folder must be mounted. Be sure, that user that launches docker container has write permissions on this folder. Can be empty.
  2. Ports 9200 and 9300 must be exposed.

Example command:

docker run -p 9200:9200 -p 9300:9300 \
    -v /local_elasticsearch_data_folder:/data \
    --name elastic -d practiceinsight/dms_elasticsearch

 

Run DMS Nuxeo suite container

Requirements to run:

  1. Ports 8080 and 9080 must be exposed.
  2. Nuxeo data folder must be mounted. Be sure, that user that launches docker container has write permissions on this folder. Can be empty.
  3. Folder containing pi-nuxeo.xml and nuxeo.conf must be mounted. nuxeo.conf.template will be added here on the first container launch.

The following parameters must be set in the nuxeo.conf:

KeySample valueDescription

nuxeo.db.name

nuxeoNuxeo database name
nuxeo.db.usernuxeoNuxeo database username
nuxeo.db.host127.0.0.1Nuxeo database hostname or ip
db (if postgres container is linked)
db.yourserver.com
nuxeo.db.port5432Nuxeo database port
nuxeo.db.passwordnuxeopNuxeo database password

elasticsearch.addressList


127.0.0.1:9300Elasticsearch server hostname or ip with port
es:9300 (if elasticsearch container is linked)
es.yourserver.com:9300
elasticsearch.clusterNameelasticsearchName of elasticsearch cluster used for the Nuxeo
elasticsearch.indexNamenuxeoName of elasticsearch Nuxeo index
elasticsearch.indexNumberOfShards5 (is default value in elasticsearch)Number of elasticsearch shards used for the Nuxeo index
elasticsearch.indexNumberOfReplicas0Number of elasticsearch replicas used for the Nuxeo index

patricia.db.jdbcDriver

com.microsoft.sqlserver.jdbc.SQLServerDriverJDBC driver to be used (must be embedded to the pi-nuxeo-marketplace)
patricia.db.jdbcUrl

jdbc:sqlserver://192.168.3.99:1433;

databaseName=patricia_GHF_demo;

integratedSecurity=false

(remove line breaks)

JDBC connection URL (the structure depends on driver)
patricia.db.username

patricia

Patricia database username
patricia.db.passwordpasswordPatricia database password
nuxeo.wizard.donetrueFlag that shows that nuxeo is already configured and no need to launch configuration wizard on the first launch

Also be sure that Nuxeo installation id is set in the pat_configuration table of Patricia DB.

Container can be linked with postgresql and elasticsearch containers then you can use "db" for postgresql and "es" for elasticsearch as a hostnames of servers in the nuxeo.conf file. 

Example command to run with containers linked:

docker run -p 8080:8080 -p 9080:9080 \
    -v /local_nuxeo_data_folder:/var/lib/nuxeo/data \
    -v /local_config_folder:/etc/nuxeo \
    --link postgres:db --link elastic:es \
    --name nuxeo practiceinsight/dms_nuxeo_suite:1.9.0

Example command to run with external servers linked, in this case be sure that these servers are configured in the nuxeo.conf and are accessible from the host machine:

docker run -p 8080:8080 -p 9080:9080 \
    -v /local_nuxeo_data_folder:/var/lib/nuxeo/data \
    -v /local_config_folder:/etc/nuxeo \
    --name nuxeo practiceinsight/dms_nuxeo_suite:1.9.0

Once all three containers are up and running, you should be able to get access to the Nuxeo with PI marketplace installed via:

http://127.0.0.1:8080/nuxeo

and to the casebrowser via:

http://127.0.0.1:9080/casebrowser
  • No labels