wolkenkit
Documentation
News
DocumentationGetting startedInstalling wolkenkitInstalling using Docker Machine

Installing using Docker Machine

To run wolkenkit using Docker Machine you need to setup a few things.

Setting up Docker

To run wolkenkit you need Docker 18.09 or higher. To setup Docker using Docker Machine, download and install Docker Toolbox.

Additionally, setup a virtualization engine such as VMware Fusion or VirtualBox. You can find the complete list of supported virtualization engines in the Docker documentation.

Enable VT-x

You may have to enable VT-x support in your machine's BIOS for Docker to work.

Using VMware Fusion

To create a virtual machine using VMware Fusion run the following command:

$ docker-machine create --driver vmwarefusion wolkenkit

Using VirtualBox

To create a virtual machine using VirtualBox run the following command:

$ docker-machine create --driver virtualbox wolkenkit

VirtualBox and macOS

Currently there is a bug within VirtualBox on macOS that affects running DNS queries from within virtual machines. Hence, after having created the virtual machine you need to run the following command:

$ VBoxManage modifyvm wolkenkit --natdnsproxy1 off --natdnshostresolver1 off

Setting up environment variables

Finally, you need to setup the environment variables DOCKER_HOST, DOCKER_TLS_VERIFY and DOCKER_CERT_PATH. To make Docker do this for you, run the following command:

$ eval $(docker-machine env wolkenkit)

To have the environment variables set automatically each time you open a terminal, you need to add them to your ~/.profile file. To do so, run:

$ docker-machine env wolkenkit >> ~/.profile

Setting up Node.js

To run wolkenkit you need Node.js 10.13.0 or higher. We recommend installing Node.js using nvm, which enables switching between different Node.js versions.

First, install nvm using this command:

$ curl -o- https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash

Then, restart your terminal and install Node.js using the following commands:

$ nvm install 10.13.0
$ nvm alias default 10.13.0
$ nvm use 10.13.0

Setting up wolkenkit

To download and install wolkenkit, run the following command:

$ npm install -g wolkenkit@3.1.0

Setting up local.wolkenkit.io

When developing wolkenkit applications you will usually run them on the domain local.wolkenkit.io. This means that you need to set up this domain inside your /etc/hosts file and make it point to the Docker server running on your previously created virtual machine. For that, run the following command:

$ sudo sh -c 'echo $(docker-machine ip wolkenkit)\\tlocal.wolkenkit.io >> /etc/hosts'

Verifying the installation

Verify that wolkenkit is installed correctly by running the following command:

$ wolkenkit --version

Yay, congratulations!

You have successfully installed wolkenkit!

To learn how to build and run your first application, have a look at creating your first application 😊!