Install on a GNU/Linux server

These instructions will work for any of the GNU/Linux distributions where Docker is supported and can be installed.

Warning

Only 64 bits distributions are supported. Do not try to install on a 32 bits operating system!

Prerequisites

You’ll need a GNU/Linux server. Because of the use of linux containerization technology, other operating systems (FreeBSD, OpenBSD, and others) are not supported.

If you don’t have a server, look at the documentation to rent one: Install in the cloud.

Dependencies:

Absolutely required dependencies:

A containerization technology such as docker or podman.

A MySQL database. Not MariaDB, MySQL. The following MySQL modes are known to work fine with eLabFTW codebase:

ERROR_FOR_DIVISION_BY_ZERO
IGNORE_SPACE
NO_ENGINE_SUBSTITUTION
NO_ZERO_DATE
NO_ZERO_IN_DATE
ONLY_FULL_GROUP_BY
PIPES_AS_CONCAT
REAL_AS_FLOAT
STRICT_ALL_TABLES

Strongly recommended dependencies:

curl, to get files from command line (very likely already installed)
docker compose plugin, the tool to orchestrate containers, required by elabctl. It can be installed with the docker-compose-plugin package.
dialog, required by elabctl install
borgbackup, a backup tool required by elabctl backup. Not required during installation.

Notes:

You can have your normal user in the docker group to execute docker commands without sudo (see documentation).

Ubuntu users: Docker as a snap is known to cause issues. Uninstall that and install it without snap. See this issue.

Install docker-compose preferentially with the curl/standalone method to get the latest version, as the repository versions might be outdated and will cause issues. See install docker-compose.

Configure eLabFTW

Warning

A proper subdomain is required!

We will install elabctl, a tool to help you manage the elabftw installation. It is not required to install it but it is quite handy so it is recommended (also it’s just a bash script, nothing fancy). If you you do not wish to use elabctl and just want a YAML config to edit, see instructions below for advanced users.

With elabctl (recommended)

# get the program (a bash script) and make it executable
curl -sL https://get.elabftw.net -o elabctl && chmod +x elabctl
# add it to a directory in your $PATH
sudo mv elabctl /usr/local/bin/

Pre-fill the configuration file:

elabctl install

Edit the configuration file:

Edit the configuration to suit your server setup. For instance, you might want to change the port binding (default is 443 but it might be already used by a traditional webserver). See below for using the container with a reverse proxy.

Note about TLS certificates

The eLabFTW container can run an HTTP or HTTPS server. Both will run internally on port 443.

Option A: HTTP mode

You can run the container in HTTP mode (internal port 443) only if you have a reverse proxy in front doing TLS termination and sending X-Forwarded-Proto header.

Set DISABLE_HTTPS=true.

Reverse proxy configurations examples can be found here.

Option B: HTTPS mode with Let’s Encrypt certificates

In order to request Let’s Encrypt certificates, you need to install certbot. See official Let’s Encrypt documentation for your system. When requesting a new certificate, make sure that port 80 is open (and also port 443 for eLabFTW if it is the one you want to use). Once certbot is installed, the command to use might look like this: certbot certonly --standalone -d elab.example.org.

Set DISABLE_HTTPS=false.
Set ENABLE_LETSENCRYPT=true.
Uncomment the line - /etc/letsencrypt:/ssl in the volumes: part of the yml config file.

Option C: HTTPS mode with custom certificates

Have the private key and certificate in PEM format in the folder /etc/letsencrypt/live/SERVER_NAME/ where SERVER_NAME matches the SERVER_NAME configuration variable. The files need to be named fullchain.pem and privkey.pem. The webserver in the container expects TLS certificates to be in a particular order and format. Make sure that your fullchain.pem file contains certificates in this order: <certificate> <intermediate ca> <root ca>, with PEM encoding.

Set DISABLE_HTTPS=false.
Set ENABLE_LETSENCRYPT=true.
Uncomment the line - /etc/letsencrypt:/ssl in the volumes: part of the yml config file.

Option D: HTTPS mode with self-signed certificate

The container can generate its own certificate. Only use this if you have no other choice, as users will see a warning that the certificate is invalid because it is self-signed.

Set DISABLE_HTTPS=false.
Set ENABLE_LETSENCRYPT=false.

Using Apache, nginx, HAProxy or traefik as a reverse proxy

Mandatory if you use Option A above (HTTP mode). All the documentation related to such configurations can be found here.

Start eLabFTW

elabctl start

Without elabctl (advanced users)

Get the config with:

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

Edit this file and docker-compose up -d to launch the containers.

Initialize your database

Import the database structure with:

elabctl initialize
# same as: docker exec -it elabftw bin/console db:install

Replace “elabftw” in the command above by the name of the elabftw container if yours is different (for instance if you have several containers running with redis as session handler). You can check this with elabctl status/docker ps