Install Prerequisites for Fuse

Fuse is built to run on top of Docker, a very popular containerization engine that makes it possible to run the same software on a large array of different systems - be it your Laptop, a server in your data-center or some cloud instance.

The Docker ecosystem consists of a couple different tools:

  • Docker Engine - the core containerization technology
  • Docker Compose - helps to run several Docker containers that depend on each other.
  • Docker Machine - a tool to create virtual machines with Docker Engine inside. Together with VirtualBox this makes it possible to run Docker containers even on computers with Windows and OS X.

Install Needed Software

Windows and OS X

To install all needed prerequisites for Fuse on your Windows or OS X machine, you can simply install the Docker Toolbox which contains all the above mentioned tools in a single easy to use point-and-click installer.

Windows

Note

The following has been tested on Microsoft Windows 10 Professional Version 1511.

Just download and run the installer for the Docker Toolbox. Note that you will need admin rights for the installation so accept the User Account Control prompt when it pops up. Use default setup during installation and make sure that on the select components screen Git for Windows is checked as well as Add docker binaries to PATH when getting to the additional tasks screen.

Once Docker Toolbox is installed we’ll need to take care of an additional step before we can start using Docker. We have just installed Git For Windows with Docker Toolbox which provides an emulated BASH environment that we will use. In order to make this easily accessible from the commandline open a command window by typing cmd into Windows Search and hit enter.

Use the following command to add Git to your PATH environment variable, make sure to use the correct installation path:

setx path "%PATH%;C:\Program Files\Git\bin"

Note

We make use of Git regularly in our Tutorials so by installing it here with Docker Toolbox you have already taken care of that requirement.

Open another command window in the same way as above and type

bash

You shoud get something like:

user@my-pc MINGW64 ~
$

Now everything should be setup and you are ready to continue with Manage a Docker Machine.

Note that if you have restarted your computer or closed the window just open a command line again, type bash and hit return to continue.

Linux

Docker Engine

curl -fsSL https://get.docker.com/ | sh

Docker Compose

curl -L https://github.com/docker/compose/releases/download/1.6.2/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose

The process of how to install the Docker tools may differ among Linux distributions. If the given commands do not work for you, please consult the instructions on the Docker website.

Manage a Docker Machine

Note

This step is only necessary on Windows or OS X.

Create Docker Machine

Since Docker nativley requires Linux to run, this will create a virtual Linux machine which runs Docker inside.

First, make sure you installed docker-machine correctly. In your terminal, type:

docker-machine --version

It should print something similar to:

docker-machine version 0.6.0, build e27fb87

Next, enter the following to create a virtual machine named fuse-vm. On Windows Virtualbox might ask for permission to make changes to your PC. Accept those when prompted.

docker-machine create --driver virtualbox --virtualbox-cpu-count 2 --virtualbox-memory 2048 fuse-vm

Note

Fuse requires at least 2GB of RAM to function, so it is important that you include the –virtualbox-memory parameter. Due to the fact that Fuse runs in a virtual machine on Windows your system needs at least 4GB to be able to provide the required 2GB for Fuse.

Once that succeeds run the following command to set the appropriate environment variables for docker - You need to run this command in every new shell or terminal window from which you want to connect to the created docker machine:

eval $(docker-machine env --shell=bash fuse-vm)

Note that shell is dependend on the actual terminal you use and can usually be omitted. It is however necessary if you are using Git BASH provided by Git for Windows on Windows to avoid command inconsistencies with the native Windows command line.

Now you can use the docker command and it will connect to the the Docker engine inside the docker machine.

To try this you can type docker ps and it will output a header line:

CONTAINER ID     IMAGE      COMMAND      CREATED        STATUS       PORTS        NAMES

If you get an error message like this:

Cannot connect to the Docker daemon. Is the docker daemon running on this host?

you most likely need to set the appropriate environment variables as written above (eval $(docker-machine env fuse-vm)).

Retrieve IP of Docker Machine

You can get the IP address of the virtual machine with the following command:

docker-machine ip fuse-vm

You will use this IP to access Fuse later on.

Remove Docker Machine

Since your docker machine is a virtual machine, it does use up hard disk and RAM. If you want to shut your virtual machine down, just enter in the following command:

docker-machine stop fuse-vm

You can always start it again:

docker-machine start fuse-vm

If you want to delete it:

docker-machine rm fuse-vm

Access Q-Sensei Docker Registry

To access Q-Sensei’s docker images, you must first register and create an account. Visit Q-Sensei Download Fuse page to retrieve login credentials. Once you have access to that page, just copy your access token and enter the following command to get access to the Q-Sensei docker repository (make sure to replace <MYTOKEN> with your token).

docker login -u token -p <MYTOKEN> -e none docker.qsensei.com

Once complete, you can pull and run the official images.

docker pull docker.qsensei.com/fuse-free

Once you have that done, try out one of our other Tutorials.