- The problem with every other developer
- Installing Docker
- Running the Desk CriSim container
- Known Issues
When you are developing software it usually runs on my machine so ship it!.
For some reason, when developing with other people it breaks on there machine
and if you lucky it breaks with a multitude of distinct, seemingly unrelated,
hard to debug error messages. So... it is because they are ⬛⬛⬛⬛⬛(removed by Administrator)
Okey, that's not fair its very difficult to create a shared development environment even
while using the same operating system and tools on the exact same version number,
things will break. This becomes extra Fun! doing it cross-platform using slightly
different tools and default configuration files that all have nice tweaks you
din't even know existed.
To overcome the painful process of creating development scrips for building, running
and testing that detect the differences, and then tweak it for every system, there
is Docker. Docker is visualization software that can run an application in a
container completely separated from the host system.
Distributing the development environment inside a container ensures that every developer has the exact same software installed and environment variables set. It could be sort of compared with installing a platform specific JVM on your system and then running platform independent java-byte code in it.
The installation of docker is a little bit different on each host operating system so I will split the operating system specific parts in its own paragraph.
⬇️Installing on Windows
⬇️Installing on MacOS
For simplicity I assume that you are running ubuntu, otherwise refere to the official documentation and follow the instructions that match your distro. Make sure that there are no previous installations active, just run:
$ sudo apt remove docker docker-engine docker.ioThis will remove it if present, or tell you that no packages are installed. Now we are ready to install docker by adding the official repository to your machine (If you don't like adding third-party repositories see installing it manually).
Fetch the latest data from the software repositories and install the required packages with the following command:
$ sudo apt update && sudo apt install apt-transport-https ca-certificates curl software-properties-commonNow add Dockers official GPG key to your trusted repositories and verify its integrity with its finger print, run:
# Fetch there public key
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
# Verify the downloaded fingerprint:
$ sudo apt-key fingerprint 0EBFCD88
# And check the output to catch sneaky NSA attacks.Finally ready to prepare to install docker, add dockers official repository with the add-apt-repository utility like this:
$ sudo add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"
# Update your cache again with the newly added repository and install the packages
$ sudo apt update && sudo apt install docker-ceIf all went well we should be able to run containers, lets try running there
hello-world image:
# This command will fetch the hello-world image and execute it in a container.
$ sudo docker run hello-worldBe patient, it could take some time to download the image, so go grab your self
some ☕ and stare at the terminal pretending to investigate complicated
terminal stuff. When docker says hello your installation is ready 👏, if
not create an create a issue
The following steps are optional but certainly recommended, otherwise you will
have to run everything prefixed with sudo, and a L33d D3V3L0P3r does his permissions right.
If your "oke" by running sudo before the docker command, then there isn't
much to do. If you want to "run it properly" and with more convenience, you should
tweak the permissions and add a new user and group: docker:docker.
# First lets create the docker group
$ sudo groupadd docker
# And add the docker user to that group
$ sudo usermod -aG docker $USERYour new membership should be re-evaluated, the easiest way to do this is by logging out and back in again, or restarting the system.
# Re-Authenticate
$ exit
# Login with you user account and test the command:
$ docker run hello-world
# If if fails, or if you just want to restart type:
$ reboot
# and wait for the system to start-up again. Login to your user account and try
# to run the docker run command:
$ docker run hello-worldWhen you want the docker daemon to start with the system, enable the systemD module by typing:
$ sudo systemctl enable dockerThats it systemD will auto start docker on each reboot, so you don't have to
worry about it.
⬇️ Go to running the Desk CriSim container
First we need to install Docker for Mac which is the free Community Edition
of Docker for MacOS, if you own a licence you can also use the non CE
edition. Download and install docker
by double clicking on the installer package Docker.dmg, then drag the docker logo
to the applications folder. Double-click Docker.app in the Applications folder to start
docker. Docker will ask you to authenticate yourself because it needs privileged access to
install the networking components. The whale icon in the top status bar indicates
that docker is running an ready to go! there are more detailed instructions on
there site if you get stuck.
After the installation finishes, a pop-up will show up that asks you to login into your docker account. If you don't have one, create a docker account and enter the credentials in the pop-up or by pressing on the docker icon in the status bar. Once logged in you can start using it from the terminal try running hello-world to check if everything works:
$ docker run hello-worldIf you get an greeting from docker, your ready to start developing Desk CriSim in it. If not check there official documentation to solve the problem.
First we need to install Docker for windows which is the free Community Edition
of Docker for Microsoft Windows, if you own a licence you can also use the non CE
edition. Download and install docker,
there are more detailed instructions on there site if you get stuck.
Optionally you can also install the desktop app
which will make managing containers and therefore your live easier.
If docker didn't start automatically after the installation (Look inside the system tray), open the start menu
and search for Docker for Windows and start it. To validate that it worked check the system tray again, there
should be a swimming wale shouting steady when hovering over it, its normal and you are good to go. If you haven't
already login with your docker id to start using it from the commandline/powershell.
If you are running Docker on Mac or Windows you are lucky because, Docker compose comes bundled with the previously installed applications. When you run into trouble visit the official documentation, on there website
After the installation finishes, a pop-up will show up that asks you to login into your docker account. If you don't have one, create a docker account and enter the credentials in the pop-up or by pressing on the docker icon in the status bar. Once logged in you can start using it from the command-line/Powershell try running hello-world to check if everything works:
$ docker run hello-worldIf you get an greeting from docker, your ready to start developing Desk CriSim in it. If not check there official documentation to solve the problem.
Everything installed correctly? Then its time to run the container, open a
terminal or cmd/Power-Shell on windows. If its the first time you try to run
the Desk Crisim container and every time you change something in the
Docker-compose.yaml or any file in the phpdocker directory, you have to
(re)build the containers image.
You can think of the image as a class in your
favorite programming language, and a container as a Object instantiated from the
class. To create a image run:
$ docker-compose buildThis will generate a image including all services defined in docker-compose.yml
and install the items configured in the phpdocker/php-fpm/Dockerfile.
When the image is created you can start it by executing:
$ docker-compose upYou will see all the services starting up in the terminals output. By default
the container is configured to bind the containers port 80 to the hosts
port 8080. This means that you can visit 127.0.0.1:8080 inside of your browser
and this will bind to the Desk Crisim containers web server on port 80, like
you would configure it in production.
If you get an error message: command not found: docker-compose when your
trying to run:
$ docker-compose upIts probably because docker is installed in a directory that is not part of your
$PATH environment variable. A solution would be creating a simlink from
the install directory to a directory that is included in $PATH, you can do
this by typing:
$ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-composeThat should do it! if not, create a issue.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.