1. Prerequisites

Important

Read first
Ensure you have read this document to understand how this documentation works.

Table of Contents

1.1. Supported host OS

The Devilbox runs on all major operating systems which provide Docker and Docker Compose. See the matrix below for supported versions:

OS Version Type Recommended
img_logo_lin Any Docker yes
       
img_logo_mac Any Docker for Mac yes
Docker Toolbox  
       
img_logo_win Windows 7 Docker Toolbox yes
Windows 10 Docker for Windows yes
Docker Toolbox  
Windows Server 2016 Docker EE yes

1.2. Required software

The only requirements for the Devilbox is to have Docker and Docker Compose installed, everything else is bundled and provided withing the Docker container. The minimum required versions are listed below:

  • Docker: 17.06.0+
  • Docker Compose: 1.16.0+

Additionally you will require git in order to clone the devilbox project.

1.3. Docker installation

1.3.1. Linux

img_logo_lin

Docker on Linux requires super user privileges which is granted to a system wide group called docker. After having installed Docker on your system, ensure that your local user is a member of the docker group.

host> id

uid=1000(cytopia) gid=1000(cytopia) groups=1000(cytopia),999(docker)

1.3.2. Mac

img_logo_mac

On MacOS Docker is available in two different forms: Docker for Mac and Docker Toolbox.

1.3.2.1. Docker for Mac

Docker for Mac is the native and recommended version to choose when using the Devilbox.

Docker for Mac requires super user privileges which is granted to a system wide group called docker. After having installed Docker on your system, ensure that your local user is a member of the docker group.

host> id

uid=502(cytopia) gid=20(staff) groups=20(staff),999(docker)

1.3.2.2. Docker Toolbox

If you still want to use Docker Toolbox, ensure you have read its drawbacks in the below provided links.

1.3.3. Windows

img_logo_win

On Windows Docker is available in two different forms: Docker for Windows and Docker Toolbox.

1.3.3.1. Docker for Windows

Docker for Windows is the native and recommended version to choose when using the Devilbox. This however is only available since Windows 10.

Docker for Windows requires administrative privileges which is granted to a system wide group called docker-users. After having installed Docker on your system, ensure that your local user is a member of the docker-users group.

1.3.3.2. Docker Toolbox

If you are on Windows 7 or still want to use Docker Toolbox, ensure you have read its drawbacks in the below provided links.

1.4. Post installation

Read the Docker documentation carefully and follow all install and post-install steps. Below are a few stumbling blocks to check that might or might not apply depending on your host operating system and your Docker version.

See also

Troubleshooting

1.4.1. User settings

Some versions of Docker require your local user to be in the docker group (or docker-users on Windows).

1.4.2. Shared drives

Some versions of Docker require you to correctly setup shared drives. Ensure the desired locations are being made available to Docker and the correct credentials are applied.

1.4.3. Network and firewall

On Windows, ensure your firewall allows access to shared drives.

1.4.4. SE Linux

Make sure to read any shortcomings when SE Linux is enabled.

1.4.5. General

It could also help to do a full system restart after the installation has been finished.

1.5. Optional previous knowledge

In order to easily work with the Devilbox you should already be familiar with the following: