Installation using Docker containers

Tutorial to run NES using a single Docker container

NeuroMat prepared a Docker container that includes all you need to use NES. This tutorial includes:

Docker installation

You can download Docker Community Edition [1] for several operational systems.

Note

Docker for Windows requires Windows 10 Professional or Windows 10 Enterprise 64-bit. For other versions (Windows 10 Home, Windows 8, or Windows 7), you must get Docker Toolbox.

Docker Toolbox installation

If you are using Windows and do not have the requirements to install Docker for Windows (see Docker installation), you can install Docker Toolbox [2]

Note

In the Select Components installation screen, select the option Git for Windows;

Note

In the Select Additional Tasks installation screen, select the option Install VirtualBox with NDISS driver (default NDIS6);

Note

After installation, running Docker Quickstart Terminal, maybe Windows Firewall block the Docker loading. In this case, stop the firewall, load Docker Quickstart Terminal, and start the firewall again.

First NES Docker container loading

After Docker (or Docker Toolbox) installation, open the terminal (or Docker Quickstart Terminal if you are using Docker Toolbox) and run the command below to download and run the NES container:

docker run -it --name nes -p 8080:8080 -p 8000:8000 neuromat/nes

Note

For data persistence it its advisable the use of Volumes [3] which are already created on NES container execution, but won’t have mnemonic references compared to manually created named volumes.

Note

Some environment variables may be set at NES container execution to adapt to your setup specific configuration. Such variables are available at NES repository on Docker Hub [4].

Accessing NES

After load the container, you are able to access the NES system using the port 8000, but the URL depends if you are using Docker or Docker Toolbox.

if you are using Docker (and not Docker Toolbox), you can access NES using localhost or the IP of your machine, e.g.:

http://localhost:8000

However, if you are using Docker Toolbox, you will have to know the IP that the Docker Toolbox designated for this loading. To know this IP, run Docker Quickstart Terminal and get the IP shown in the first line. Now, you can call the URL:

http://<docker ip>:8000

After access the login page, use the user nes_admin (password nes_admin_password).

Accessing LimeSurvey

This container also contains a LimeSurvey installation. Its access is from the port 8080 and the URL depends if you are using Docker or Docker Toolbox (see Accessing NES):

http://localhost:8080/admin

or:

http://<docker ip>:8080/admin

After access the LimeSurvey login page, use the user limesurvey_admin (password limesurvey_admin_password).

Using NES Docker container after first loading

After the first loading, NES container is already downloaded and installed in your machine. However, when you restart the machine, the container is stopped. Then, to load it again, it is necessary to start the NES container using the following command:

docker start nes

Useful information

  • For more detailed information see NES repository on Docker Hub [4]
  • Container NES database access: user nes_user, password nes_password
  • Container LimeSurvey database access: user limesurvey_user, password limesurvey_password

Tutorial to run NES using Docker Compose

Assuming you have already installed Docker (see Docker installation and Docker Toolbox installation), you have already installed Docker Compose aswell, since they come packed together and there is no need for extra configuration.

This tutorial includes:

Building docker-compose file

In order to run the composed version of NES you need to build a docker-compose.yml file, for such you may use the following example:

version: '2'
services:

  # Postgres_LimeSurvey
  db_limesurvey:
    image: postgres:alpine
    volumes:
      - "limesurvey_pgdata:/var/lib/postgresql/data"
    environment:
      - POSTGRES_PASSWORD=limesurvey_password
      - POSTGRES_DB=limesurvey_db
      - POSTGRES_USER=limesurvey_user

  # LimeSurvey
  limesurvey:
    image: neuromat/nes-compose:limesurvey
    volumes:
      - "limesurvey_data:/var/www/limesurvey"
    environment:
      - LIMESURVEY_PORT=8080
      - LIMESURVEY_DB_TYPE=pgsql
      - LIMESURVEY_DB_HOST=db_limesurvey
      - LIMESURVEY_DB_PORT=5432
      - LIMESURVEY_DB=limesurvey_db
      - LIMESURVEY_DB_TABLE_PREFIX=lime_
      - LIMESURVEY_DB_USER=limesurvey_user
      - LIMESURVEY_DB_PASSWORD=limesurvey_password
      - LIMESURVEY_ADMIN_USER=limesurvey_admin
      - LIMESURVEY_ADMIN_NAME=limesurvey_admin
      - LIMESURVEY_ADMIN_EMAIL=limesurvey@limemail.com
      - LIMESURVEY_ADMIN_PASSWORD=limesurvey_admin_password
      - LIMESURVEY_URL_FORMAT=path
    ports:
      - "8080:8080"
    depends_on:
      - db_limesurvey

  # Postgres_NES
  db_nes:
    image: postgres:alpine
    volumes:
      - "nes_pgdata:/var/lib/postgresql/data"
    environment:
      - POSTGRES_PASSWORD=nes_password
      - POSTGRES_DB=nes_db
      - POSTGRES_USER=nes_user

  # Neuroscience Experiments System
  nes:
    image: neuromat/nes-compose:nes
    volumes:
      - "nes_data:/nes"
    environment:
      - NES_DB_TYPE=pgsql
      - NES_DB_HOST=db_nes
      - NES_DB=nes_db
      - NES_DB_USER=nes_user
      - NES_DB_PASSWORD=nes_password
      - NES_DB_PORT=5432
      - LIMESURVEY_HOST=limesurvey
      - LIMESURVEY_PORT=8080
      - LIMESURVEY_ADMIN_USER=limesurvey_admin
      - LIMESURVEY_ADMIN_PASSWORD=limesurvey_admin_password
      - NES_SECRET_KEY=_my_very_secret_key_
      - NES_IP=0.0.0.0
      - NES_PORT=8000
      - NES_ADMIN_USER=nes_admin
      - NES_ADMIN_EMAIL=nes_admin@nesmail.com
      - NES_ADMIN_PASSWORD=nes_admin_password
    stdin_open: true
    tty: true
    ports:
     - "8000:8000"
    depends_on:
      - db_nes
      - limesurvey

volumes:
  limesurvey_pgdata:
  nes_pgdata:
  limesurvey_data:
  nes_data:

More information regarding environmennt variables and service itegration for the composed version of NES can be found in NES-compose repository on Docker Hub [5].

Running the composed NES container

After setting up the docker-compose file in Building docker-compose file you just need to run the following command to have a fully deployed container version of NES:

docker-compose up

From this step onward, NES and LimeSurvey acess will behave the same as in the single container setup (see Accessing NES and Accessing LimeSurvey).

Additional information