7.6 KiB
Prerequisites
Important
read_first Ensure you have read this document to understand how this documentation works.
Table of Contents
- local
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 |
|---|---|---|---|
| Any | yes | ||
|
|
-------------+ |
|
|
|
-------------+ yes -------------+
|
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: 1.12.0+Docker Compose: 1.9.0+
Additionally you will require git in order to clone the devilbox project.
howto_find_docker_and_docker_compose_version
Docker installation
Linux
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)- (covers
dockergroup)
Mac
On MacOS Docker is available in two different forms: Docker for Mac and Docker Toolbox.
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)- Docker for Mac
Docker Toolbox
If you still want to use Docker Toolbox, ensure you have read its drawbacks in the below provided links.
- Docker Toolbox
Important
howto_docker_toolbox_and_the_devilbox
Windows
On Windows Docker is available in two different forms: Docker for Windows and Docker Toolbox.
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.
- Docker for Windows
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.
- Docker Toolbox
Important
howto_docker_toolbox_and_the_devilbox
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.
troubleshooting
User settings
Some versions of Docker require your local user to be in the docker group (or docker-users on Windows).
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.
Network and firewall
On Windows, ensure your firewall allows access to shared drives.
SE Linux
Make sure to read any shortcomings when SE Linux is enabled.
General
It could also help to do a full system restart after the installation has been finished.
Optional previous knowledge
In order to easily work with the Devilbox you should already be familiar with the following:
- Navigate on the command line
- Docker Compose commands (
up,stop,kill,rm,logs,pull) - Docker Compose
.envfile - Know how to use
git
troubleshooting