https://github.com/elabftw/elabimg

Official eLabFTW Docker image
https://github.com/elabftw/elabimg

docker docker-container elabftw mysql nginx php

Last synced: 3 days ago
JSON representation

Official eLabFTW Docker image

• Host: GitHub
• URL: https://github.com/elabftw/elabimg
• Owner: elabftw
• License: agpl-3.0
• Created: 2015-05-13T14:57:08.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-03-31T21:48:10.000Z (8 months ago)
• Last Synced: 2024-03-31T22:35:03.086Z (8 months ago)
• Topics: docker, docker-container, elabftw, mysql, nginx, php
• Language: HTML
• Homepage: https://www.elabftw.net
• Size: 2.89 MB
• Stars: 15
• Watchers: 4
• Forks: 31
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Description

This Docker image is for [eLabFTW](https://www.elabftw.net). It runs three services:

* Nginx webserver

* PHP-FPM service

* Cron daemon to execute recurrent tasks (sending notifications)

These services are managed by s6-overlay and are all customized for running eLabFTW.

# Tags

Tags, in the context of Docker images, are what comes after the image name (`elabftw/elabimg`), separated by a colon. If you leave it empty, it defaults to `latest`. But it is recommended to explicitly define the version you wish to run, e.g.: `elabftw/elabimg:5.0.3`.

When defining which image version to use, you can use different tags:

* `x.y.z`: the actual explicit version: recommended

* `stable`: the latest stable version

* `latest`: the latest version, can be a stable version or an alpha or beta, whatever is present on `master` branch of eLabFTW

* `hypernext`: this is the dev version, built on a "push" event as well as on a daily schedule.

# Building this image

Set the `ELABFTW_VERSION` to a tagged release or a branch. The latest stable version can be found [here](https://github.com/elabftw/elabftw/releases/latest).

~~~bash

DOCKER_BUILDKIT=1 docker build --build-arg ELABFTW_VERSION=X.Y.Z -t elabftw/elabimg:X.Y.Z .

~~~

For dev, add `--build-arg BUILD_ALL=0` to skip the installation of dependencies and building of assets, because the folder will be bind-mounted to your host anyway.

# Usage

An example configuration file for docker-compose can be fetched like this:

~~~bash

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

~~~

After downloading the configuration file, open it in your preferred text editor to modify settings as necessary.

For usage of eLabFTW, see [documentation](https://doc.elabftw.net).

## Reloading services

If for some reason you wish to reload a service without restarting the container (for instance when trying configuration changes), you can use ``reload``:

~~~bash

# reload php and nginx

reload

# reload only php

reload php

# reload only nginx

reload nginx

~~~

## Deleting GitHub build cache

If there is a CVE fixed upstream, delete build cache with:

~~~bash

gh cache delete --all

~~~

Requires GitHub CLI: https://cli.github.com/