Galaxy instance with ChIP-exo tools shipped in a Docker container. 🐳
First you need to install docker for your platform by following the instruction at https://docs.docker.com/installation/
If running on OS X (skip this if running on Linux), after successful installation, get the default IP address used by docker:
docker-machine ip default
The above command should display an IP address like this:
192.168.99.100
Now do this (no matter the OS):
docker run -d -p 8080:80 gregvonkuster/docker-galaxy-chip-exo
Consult the docker manual for detailed information about using docker (it is really worth reading).
Quick start:
docker run will run the Image/Container for you. If you do not have the Container stored locally, docker will download it for you.
-d will start the docker container in daemon mode.
-p 8080:80 will make port 80 (inside the container) available on port 8080 of your computer. Within the container an Apache Webserver
is running on port 80 and that port can be bound to a local port on your computer. With this parameter you can access your Galaxy
instance by pointing your browser to http://localhost:8080 if running on Linux. On OS X use the default docker IP address you
discovered above (e.g., http://192.168.99.100).
gregvonkuster/galaxy-chip-exo is the Image/Container name that directs docker to the correct path in the
docker index.
:master is the specific tag of the Image/Container that will be pulled from the docker index and run.
For an interactive session, you can execute:
docker run -i -t -p 8080:80 gregvonkuster/docker-galaxy-chip-exo /bin/bash
and run the startup script yourself to start PostgreSQL, Apache and Galaxy.
The contents of the Container can be changed within a session, but all of your changes will be lost after restart. You have to manually copy altered code files and export calculated data to your host computer if you want them saved when the docker session ends.
Fortunately, this is as easy as:
docker run -d -p 8080:80 -v /home/user/galaxy_storage/:/export/ gregvonkuster/docker-galaxy-chip-exo
With the additional -v /home/user/galaxy_storage/:/export/ parameter, docker will mount the folder /home/user/galaxy_storage into the Container under /export/. A startup.sh script that starts Apache, PostgreSQL and Galaxy within the Container will recognize the export directory with one of the following results:
- In case of an empty
/export/directory, it will move the PostgreSQL database, the Galaxy database directory, Shed Tools, Tool Dependencies and various configuration scripts to /export/ and symlink back to the original location. - In case of a non-empty
/export/, (e.g.,if you continue a previous session within the same folder) nothing will be moved, but the symlinks will be created.
This enables you to have different export folders for different sessions - i.e., real separation of your different projects.
With the additional -v /home/user/galaxy_storage/:/export/ parameter, docker will mount the folder /home/user/galaxy_storage
into the Container under /export/. A startup.sh script that starts Apache, PostgreSQL and Galaxy will recognize the export
directory with one of the following results:
- In case of an empty
/export/directory, it will move the PostgreSQL database, the Galaxy database directory, Shed Tools and Tool Dependencies and various config scripts to /export/ and symlink back to the original location. - In case of a non-empty
/export/(e.g., if you continue a previous session within the same folder), nothing will be moved, but the symlinks will be created.
This enables you to have different export folders for different sessions - i.e., real separation of your different projects.
Interactive Environments (IE) are sophisticated ways to extend Galaxy with powerful services, like IPython, in a secure and reproducible way. For this we need to be able to launch Docker containers inside our Galaxy Docker container. Docker 1.3 or newer is needed on the host system.
docker run -d -p 8080:80 -p 8021:21 -p 8800:8800 --privileged=true -v /home/user/galaxy_storage/:/export/ gregvonkuster/docker-galaxy-chip-exo
The port 8800 is the proxy port that is used to handle Interactive Environments. --privileged is needed to start docker containers inside docker.
On some linux distributions, Docker-In-Docker can run into issues (such as running out of loopback interfaces). If this is an issue, you can use a 'legacy' mode that uses a docker socket for the parent docker installation mounted inside the container. To engage, set the environment variable DOCKER_PARENT
docker run -d -p 8080:80 -p 8021:21 -p 8800:8800 --privileged=true -e DOCKER_PARENT=True -v /var/run/docker.sock:/var/run/docker.sock -v /home/user/galaxy_storage/:/export/ gregvonkuster/docker-galaxy-chip-exo
The Galaxy Admin User has the username [email protected] and the password admin.
The PostgreSQL username is galaxy, the password is galaxy and the database name is galaxy.
To create new users, make sure to use the /export/ volume or the user will be eliminated after your docker session ends.
- Bjoern Gruening
- Greg von Kuster
- 0.1: Initial release!
For support, questions, or feature requests please see https://github.com/gregvonkuster/galaxy-ChIP-exo/issues.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.