Commit edfb9a0e authored by flothoni's avatar flothoni Committed by Mathieu Giraud

doc/; update content for docker installation

This documentation come from doc/dev
parent 9a6421a9
......@@ -103,9 +103,26 @@ These instructions are preliminary, other documentation can also be found in [[h
- 1.3
- 1.3.1
- 1.3.2
- tmp_fix
This image is identical to 1.3.2 except it has a manual bugfix on pyDAL
version 17.11 that was affecting the scheduler_workers.
- 1.4.2
*** Docker environment
The vidjil Docker environment is managed by Docker Compose since it is
composed of several different services this allows us to easily start and
stop individual services.
The services are as follows:
- mysql The database
- uwsgi The Web2py backend server
- fuse The XmlRPCServer that handles custom fuses (for comparing
- nginx The web server
- workers The Web2py Scheduler workers in charge of executing vidjil
users' samples
- backup Starts a cron job to schedule regular backups
- reporter A monitoring utility that can be configured to send
monitoring information to a remote server
For more information about Docker Compose and how to install it check out
*** Configuring the Vidjil container
......@@ -164,6 +181,33 @@ These instructions are preliminary, other documentation can also be found in [[h
- Configure the reporter. Ideally this container should be positioned
on a remote server in order to be able to report on a down server, but we have packed it here for convenience.
*** Starting the environment
Ensure your docker-compose.yml contains the correct reference to the
vidjil image you want to use. Usually this will be vidjil/vidjil:latest,
but more tags are available at
You may also want to uncomment the volume in the fuse volume block "-
./vidjil/conf:/etc/vidjil" this will provide easier access to all of the
configuration files, allowing for tweaks. From this location, it will be easier to enable more softwaer or pipelines by putting the binary in this location taht will be see by the docker instance.
Running the following command will automatically download any missing
images and start the environment:
docker-compose up
If you are using the backup and reporter images, then you need to first
build these from the image you are using by running the following:
docker-compose up --build
This will also start the environment for you.
*** Updating a Docker installation
Usually our docker installation will only require the following:
......@@ -8,7 +8,7 @@ services:
- ./mysql/:/docker-entrypoint-initdb.d/
- /opt/vidjil/mysql:/var/lib/mysql
image: vidjil/server:test
image: vidjil/server:latest
command: bash /entrypoints/
- fuse
......@@ -19,7 +19,7 @@ services:
- mysql:mysql
- fuse:fuse
image: vidjil/server:test
image: vidjil/server:latest
command: bash /entrypoints/
- /opt/vidjil/databases:/usr/share/vidjil/server/web2py/applications/vidjil/databases
......@@ -31,7 +31,7 @@ services:
- /opt/vidjil/backup:/mnt/backup
#- ./vidjil-server/conf:/etc/vidjil
image: vidjil/client:test
image: vidjil/client:latest
- uwsgi
......@@ -46,7 +46,7 @@ services:
- ../germline:/usr/share/vidjil/germline
image: vidjil/server:test
image: vidjil/server:latest
command: /usr/local/bin/gosu www-data python /usr/share/vidjil/server/web2py/ -K vidjil,vidjil,vidjil
- uwsgi
......@@ -56,7 +56,7 @@ services:
- mysql
image: vidjil/server:test
image: vidjil/server:latest
command: bash -c "echo '0 5 * * * cd /usr/share/vidjil/server; sh /mnt/backup 2>1&' > /etc/cron.d/backup-cron && cron"
- uwsgi
......@@ -64,7 +64,7 @@ services:
- mysql
build: ./reporter
image: reporter:test
image: reporter:latest
- uwsgi
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment