Install on a Qnap NAS

qnap

Tested with firmware version 4.3.6 on a TVS-EC1080.

Note

This has been reported to work on a Synology NAS

This page describes the installation of eLabFTW on a Qnap NAS. The procedure slightly different than on a normal GNU/Linux server.

Prerequisites

We will use the Docker container technology, so you need to install the Container Station app from the AppCenter.

container-app

Once it is installed, open it. It will create a /Container folder. Connect with SSH to the NAS and create subfolders for storing eLabFTW files:

cd /share/CACHEDEV1_DATA # path might be different on your system
mkdir -p Container/elabftw/mysql
mkdir Container/elabftw/web

Get the config file

cd /share/CACHEDEV1_DATA/Container/elabftw
curl -so docker-compose.yml "https://get.elabftw.net/?config"

Edit the config file

To edit the file we just downloaded, you can use “vim” or just download it on your computer instead, edit it with your favorite text editor and upload it back.

You need to edit the port binding of the elabftw container. So change ‘443:443’ to ‘3148:443’ of the “ports” section of the “web” service.

You also need to edit the “volumes” bindings so that persistent files (MySQL database and uploaded files) are stored there. In the example below, the paths are relative because the “docker-compose.yml” file is in the folder where we expect to store the files, but you can also put an absolute path:

nas config nas config

Starting the containers

docker-compose up -d

Accessing elabftw

Wait 10 seconds and go to https://YOUR.NAS.IP:3148. You should see the register page.

Post install

Don’t forget to read the post install page, setup backup, and subscribe to the newsletter!

To update, you can do “docker-compose pull” and “docker-compose up -d”.

ENJOY! :D