mykitserver/docker-limesurvey
1
0
Fork 0
mirror of https://github.com/mykitserver/docker-limesurvey.git synced 2025-12-06 16:39:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Added paragraph listing the credentials used in example docker-compose files, with warning to change if use for anything beyond testing.

Edited Description for ADMIN_USER and ADMIN_NAME to clarify which parameters are used for signing into the admin panel. (Previously ADMIN_NAME's description included the word username, which is confusing as it is not the username used to sign into the admin panel)
This commit is contained in:
Mark
2023-09-06 09:57:44 -04:00
committed by GitHub
parent 9135f556f5
commit 265b375fc1
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -115,10 +115,10 @@ If you are running LimeSurvey behind a Reverse Proxy you might need some additio
| DB_MYSQL_ENGINE | MySQL engine used for survey tables (values: MyISAM, InnoDB, default: MyISAM) | | DB_MYSQL_ENGINE | MySQL engine used for survey tables (values: MyISAM, InnoDB, default: MyISAM) |
| DB_USERNAME | Database user | | DB_USERNAME | Database user |
| DB_PASSWORD | Database user's password | | DB_PASSWORD | Database user's password |
| ADMIN_USER | Initial LimeSurvey Admin User | | ADMIN_USER | Initial LimeSurvey Admin Username (for signing into admin panel) |
| ADMIN_NAME | Initial LimeSurvey Admin Username | | ADMIN_NAME | Initial LimeSurvey Admin Name |
| ADMIN_EMAIL | Initial LimeSurvey Admin Email | | ADMIN_EMAIL | Initial LimeSurvey Admin Email |
| ADMIN_PASSWORD | Initial LimeSurvey Admin Password | | ADMIN_PASSWORD | Initial LimeSurvey Admin Password (for signing into admin panel) |
| PUBLIC_URL | Public URL for public scripts | | PUBLIC_URL | Public URL for public scripts |
| BASE_URL | Application Base URL | | BASE_URL | Application Base URL |
| URL_FORMAT | URL Format. path or get | | URL_FORMAT | URL Format. path or get |
@@ -149,7 +149,7 @@ For further details on the settings see: https://manual.limesurvey.org/Optional_
# Running LimeSurvey with docker-compose # Running LimeSurvey with docker-compose
The easiest way to get a fully featured and functional setup is using a docker-compose file. Several examples are provided in the [repository](https://github.com/martialblog/docker-limesurvey). To sign into the example admin panel the credentials are username: *admin* password: *foobar*. The easiest way to get a fully featured and functional setup is using a docker-compose file. Several examples are provided in the [repository](https://github.com/martialblog/docker-limesurvey).
``` ```
docker-compose up docker-compose up
@@ -161,6 +161,8 @@ http://localhost:8080/
http://localhost:8080/index.php/admin http://localhost:8080/index.php/admin
``` ```
Please note / warning: To sign into the admin panel in the examples, the credentials are username: *admin* password: *foobar*, however, if you are planning for any use beyond testing, it is highly recommended that you use environment variables to define a secure username and password.
# Running LimeSurvey with Helm # Running LimeSurvey with Helm
A Helm Chart for this Image can be used for deployments. Please refer to the Helm Repository for further details: A Helm Chart for this Image can be used for deployments. Please refer to the Helm Repository for further details: