nfrastack/container-limesurvey

About

This repository will build a conatiner image for running LimeSurvey - A Surveying Platform.

Maintainer

• Nfrastack

Table of Contents

• About
• Maintainer
• Table of Contents
• Installation
  • Prebuilt Images
  • Quick Start
  • Persistent Storage
• Configuration
  • Environment Variables
    • Base Images used
    • Core Configuration
  • Users and Groups
  • Networking
• Maintenance
  • Shell Access
• Support & Maintenance
• License
• References

Installation

Prebuilt Images

Feature limited builds of the image are available on the Github Container Registry and Docker Hub.

To unlock advanced features, one must provide a code to be able to change specific environment variables from defaults. Support the development to gain access to a code.

To get access to the image use your container orchestrator to pull from the following locations:

ghcr.io/nfrastack/container-limesurvey:(image_tag)
docker.io/nfrastack/limesurvey:(image_tag)

Image tag syntax is:

<image>:<branch>-<optional tag>-<optional phpversion>

Example:

docker.io/nfrastack/container-limesurvey:latest or

ghcr.io/nfrastack/container-limesurvey:6-1.0 or

ghcr.io/nfrastack/container-limesurvey:6-2.0-php84

• latest will be the most recent commit

• branch will be the repositories branch, typically matching with the major version of LimeSurvey eg 6

• An optional tag may exist that matches the CHANGELOG - These are the safest

• An optional phpversion may exist like php84 or php83

Have a look at the container registries and see what tags are available.

Multi-Architecture Support

Images are built for amd64 by default, with optional support for arm64 and other architectures.

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for your use.

• Map persistent storage for access to configuration and data files for backup.

• Set various environment variables to understand the capabilities of this image.

Persistent Storage

The following directories/files should be mapped for persistent storage in order to utilize the container effectively.

Directory	Description
/logs	Nginx and PHP Log files
/www/html	Limesurvey sourcecode

Environment Variables

Base Images used

This image relies on a customized base image in order to work. Be sure to view the following repositories to understand all the customizable options:

Image	Description
OS Base	Base Image
Nginx	Nginx Webserver
Nginx PHP-FPM	PHP-FPM Interpreter

Below is the complete list of available options that can be used to customize your installation.

• Variables showing an 'x' under the Advanced column can only be set if the containers advanced functionality is enabled.

Core Configuration

Parameter	Description	Default	_FILE
ADMIN_USER	Username of Administrator Account	admin	x
ADMIN_NAME	Full name of Administrator Account		Admin
ADMIN_PASS	Password of Administrator account		x
ADMIN_EMAIL	Email address of Administrator Account	admin@example.com	x
DB_HOST	Host or container name of MariaDB Server e.g. limesurvey-db		x
DB_NAME	MariaDB Database name e.g. limesurvey		x
DB_PASS	MariaDB Password for above Database e.g. password		x
DB_PORT	MariaDB Port	3306	x
DB_USER	MariaDB Username for above Database e.g. limesurvey		x
DB_CHARSET	MariaDB Character Set	utf8mb4	x
DB_TABLE_PREFIX	Database Table Prefix	lime_	x
URL_FORMAT	URL Format	path
PUBLIC_URL	Public URL to adverstise application

---

Maintenance

Shell Access

For debugging and maintenance, bash and sh are available in the container.

Support & Maintenance

• For community help, tips, and community discussions, visit the Discussions board.
• For personalized support or a support agreement, see Nfrastack Support.
• To report bugs, submit a Bug Report. Usage questions will be closed as not-a-bug.
• Feature requests are welcome, but not guaranteed. For prioritized development, consider a support agreement.
• Updates are best-effort, with priority given to active production use and support agreements.

License

This project is licensed under the MIT License - see the LICENSE file for details.