Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamzammit/limesurvey-docker
Production ready dockerised Limesurvey
https://github.com/adamzammit/limesurvey-docker
Last synced: 3 months ago
JSON representation
Production ready dockerised Limesurvey
- Host: GitHub
- URL: https://github.com/adamzammit/limesurvey-docker
- Owner: adamzammit
- License: gpl-3.0
- Fork: true (crramirez/limesurvey)
- Created: 2016-08-15T01:29:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T01:31:56.000Z (8 months ago)
- Last Synced: 2024-04-09T02:13:15.020Z (8 months ago)
- Language: Shell
- Homepage:
- Size: 45.8 MB
- Stars: 76
- Watchers: 11
- Forks: 50
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
LimeSurvey
==========
#IMPORTANT NOTE for installations from 4.0.0 to 5.0.8 (fixed if you use a NEW install from 5.0.8.1 onwards) - POTENTIAL DATA LOSS
If you are using a version of this container from 4.0.0 to 5.0.8 inclusive AND your users have encrypted any data within LimeSurvey - please ensure to make a backup of /var/www/html/application/config/security.php before updating your image.
An example of how to do this is below, assuming the container name is 'some-limesurvey':
```console
$ docker cp some-limesurvey:/var/www/html/application/config/security.php /tmp/security.php
```
Then update to 5.0.8.1 or greater. You can then copy the security.php file back:
```console
$ docker cp /tmp/security.php some-limesurvey:/var/www/html/application/config/security.php
```
5.0.8.1 or greater will persist the config directory.
#END IMPORTANT NOTE
LimeSurvey - the most popular
Free Open Source Software survey tool on the web.
https://www.limesurvey.org/en/
This docker image is for Limesurvey on apache/php in its own container. It accepts environment variables to update the configuration file. On first run it will automatically create the database if a username and password are supplied, and on subsequent runs it can update the administrator password if provided as an environment variable.
Volumes are specified for plugins and upload directories for persistence.
# Tags
- latest - Tracks LimeSurvey latest stable release
- lts - Tracks LimeSurvey LTS release
Tags corresponding to version on https://community.limesurvey.org/downloads/
# How to use this image
```console
$ docker run --name some-limesurvey --link some-mysql:mysql -d adamzammit/limesurvey
```
The following environment variables are also honored for configuring your Limesurvey instance. If Limesurvey is already installed, these environment variables will update the Limesurvey config file.
- `-e LIMESURVEY_DB_TYPE=...` (defaults to 'mysql', change to 'pgsql' as needed)
- `-e LIMESURVEY_DB_HOST=...` (defaults to the IP and port of the linked `mysql` container)
- `-e LIMESURVEY_DB_PORT=...` (defaults to 3306, _must_ change to e.g. 5432 if a Postgres database is used)
- `-e LIMESURVEY_DB_USER=...` (defaults to "root")
- `-e LIMESURVEY_DB_PASSWORD=...` (defaults to the value of the `MYSQL_ROOT_PASSWORD` environment variable from the linked `mysql` container)
- `-e LIMESURVEY_DB_NAME=...` (defaults to "limesurvey")
- `-e LIMESURVEY_TABLE_PREFIX=...` (defaults to "" - set this to "lime_" for example if your database has a prefix)
- `-e LIMESURVEY_ADMIN_USER=...` (defaults to "" - the username of the Limesurvey administrator)
- `-e LIMESURVEY_ADMIN_PASSWORD=...` (defaults to "" - the password of the Limesurvey administrator)
- `-e LIMESURVEY_ADMIN_NAME=...` (defaults to "Lime Administrator" - The full name of the Limesurvey administrator)
- `-e LIMESURVEY_ADMIN_EMAIL=...` (defaults to "[email protected]" - The email address of the Limesurvey administrator)
- `-e LIMESURVEY_FROM_EMAIL=...` (defaults to "[email protected]" - The email address where messages will be sent from)
- `-e LIMESURVEY_SMTP_HOST=...` (defaults to "" - set the SMTP host - you can also specify a different port than 25 by using this format: [hostname:port], e.g. "smtp.example.com:587")
- `-e LIMESURVEY_SMTP_USER=...` (defaults to "" - only set this if your server requires authorization - if you set it you HAVE to set a password too)
- `-e LIMESURVEY_SMTP_PASSWORD=...` (defaults to "" - SMTP authorization password - empty password is not allowed)
- `-e LIMESURVEY_SMTP_SSL=...` (defaults to "" - set this to "ssl" to use SSL/TLS or "tls" to use StartTLS for SMTP connection)
- `-e LIMESURVEY_DEBUG=...` (defaults to 0 - Debug level of Limesurvey, 0 is off, 1 for errors, 2 for strict PHP and to be able to edit standard templates)
- `-e LIMESURVEY_SMTP_DEBUG=...` (defaults to "" - set this to any value to enable SMTP debug mode)
- `-e LIMESURVEY_SQL_DEBUG=...` (defaults to 0 - Debug level of Limesurvey for SQL, 0 is off, 1 is on - note requires LIMESURVEY_DEBUG set to 2)
- `-e LIMESURVEY_USE_INNODB=...` (defaults to '' - Leave blank or don't set to use standard MyISAM database. Set to any value to use InnoDB (required for some cloud providers))
- `-e LIMESURVEY_USE_DB_SESSIONS=...` (defaults to '' - Leave blank or don't set to use file based sessions. Set to any value to use DB based sessions
- `-e LIMESURVEY_PHP_SESSION_SAVE_HANDLER=...` (defaults to '' - Leave blank or don't set to use default sessions. Set to the desired handler (eg redis, memcached) if you want to specify. Must use in conjuction with LIMESURVEY_PHP_SESSION_SAVE_PATH
- `-e LIMESURVEY_PHP_SESSION_SAVE_PATH=...` (defaults to '' - Leave blank or don't set to use default sessions. Set to the desired session path if you want to specify. Must use in conjuction with LIMESURVEY_PHP_SESSION_SAVE_HANDLER
- `-e LIMESURVEY_DONT_SHOW_SCRIPT_NAME=...` (defaults to '' - Leave blank or don't set to show the script name `index.php` in URLs. Set to any value to omit the script name)
- `-e LIMESURVEY_DONT_UPDATE=...` (defaults to '' - Leave blank or don't set for normal startup, set to any value to avoid updating password, config settings, and clearning cache)
- `-e MYSQL_SSL_CA=...` (path to an SSL CA for MySQL based in the root directory (/var/www/html). If changing paths, escape your forward slashes. Do not set or leave blank for a non SSL connection). If set to "BaltimoreCyberTrustRoot.crt.pem", the certificate is downloaded before the application is started (see [https://learn.microsoft.com/en-us/azure/mysql/single-server/how-to-configure-ssl#step-1-obtain-ssl-certificate](https://learn.microsoft.com/en-us/azure/mysql/single-server/how-to-configure-ssl#step-1-obtain-ssl-certificate)). If set to "global-bundle.pem" - will download Amazon certificate from: https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem - SECURITY NOTE: By default this image sets PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT to "false" for compatability reasons
- `-e TZ=...` Time zone name. If set, will configure PHP and LimeSurvey to use this time zone
If the `LIMESURVEY_DB_NAME` specified does not already exist on the given MySQL server, it will be created automatically upon startup of the `limesurvey` container, provided that the `LIMESURVEY_DB_USER` specified has the necessary permissions to create it.
If you'd like to be able to access the instance from the host without the container's IP, standard port mappings can be used:
```console
$ docker run --name some-limesurvey --link some-mysql:mysql -p 8080:80 -d adamzammit/limesurvey
```
Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser.
If you'd like to use an external database instead of a linked `mysql` container, specify the hostname and port with `LIMESURVEY_DB_HOST` along with the password in `LIMESURVEY_DB_PASSWORD` and the username in `LIMESURVEY_DB_USER` (if it is something other than `root`):
```console
$ docker run --name some-limesurvey -e LIMESURVEY_DB_HOST=10.1.2.3:3306 \
-e LIMESURVEY_DB_USER=... -e LIMESURVEY_DB_PASSWORD=... -d adamzammit/limesurvey
```
## Volumes and Persistence
Since 5.6.11 there are now 4 volumes defined in the Dockerfile:
1. /var/www/html/plugins
- Installed LimeSurvey plugins
2. /var/www/html/upload
- New or created themes, Survey resources, Data from uploaded responses
3. /var/www/html/application/config
- Configuration and security.php for encrypted responses
4. /var/lime/sessions
- Sessions if using file based sessions (default)
## ... via [`docker-compose`](https://github.com/docker/compose)
Example `docker-compose.yml` for `limesurvey`:
```yaml
version: '2'
services:
limesurvey:
image: adamzammit/limesurvey
ports:
- 8082:80
environment:
LIMESURVEY_DB_PASSWORD: example
LIMESURVEY_ADMIN_USER: admin
LIMESURVEY_ADMIN_PASSWORD: password
LIMESURVEY_ADMIN_NAME: Lime Administrator
LIMESURVEY_ADMIN_EMAIL: [email protected]
volumes:
- ./plugins:/var/www/html/plugins
- ./upload:/var/www/html/upload
- ./config:/var/www/html/application/config
- ./sessions:/var/lime/sessions
mysql:
image: mariadb:10.5
environment:
MYSQL_ROOT_PASSWORD: example
```
Run `docker-compose up`, wait for it to initialize completely, and visit `http://localhost:8082` or `http://host-ip:8082`.
# Supported Docker versions
This image is officially supported on Docker version 1.12.3.
Support for older versions (down to 1.6) is provided on a best-effort basis.
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
Notes
-----
This Dockerfile is based on the Dockerfile from the [Wordpress official docker image](https://github.com/docker-library/wordpress/tree/8ab70dd61a996d58c0addf4867a768efe649bf65/php5.6/apache)