README.md

Dokman

DOcKer MANager

This is a bash helper library for easier working with docker-compose. Main goal of this library is to reduce everyday typing. As docker has docker-compose to easier orchestrate with docker containers now developer has dokman for easier working with docker-compose enabling commonly used docker commands.

Main purpose for creating this library was to unify docker workflow on multiple projects.

This library allows you to:

• easily setup multiple environments of your docker setup (ie. production, development, test...)
• have easy access to your docker containers (less typing)
• same docker philosophy on multiple projects
• whole docker is wrapped in easy to use shorthands
• docker-compose commands are wrapped in that manner to reduce typing with our special commands
• event system that will ease your life with setting up project
• support for waiting containers until they become healthy

Pre-requirements

Dokman pre-requires for you to have docker and docker-compose installed and running.

For easier working with docker in general, add your user to docker group, so you will not need to write every docker command with sudo.

sudo usermod -aG docker ${USER}

Note: Dokman will populate environment variables with your current user and group id so you can easily create shadow user.

Index

1. Install
   1. Update
   2. Structure
2. Environments
   1. Simple setup
   2. Complex setup
3. Special variables
4. Events
5. Helper scripts
   1. enter
   2. env
   3. install
   4. run
6. Health check scripts
7. FAQ