From 8ec394c7af9b9a102e81ce1dec2521d5d4bbd3b4 Mon Sep 17 00:00:00 2001 From: Mark Date: Tue, 5 Sep 2023 13:15:06 -0400 Subject: [PATCH 1/3] Update README.md Save some time for people who want to test out LimeSurvey using the sample docker-compose files so that they don't need to go poking around the different files to find the example credentials used. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0fc8db2c5..9688835b0 100644 --- a/README.md +++ b/README.md @@ -159,6 +159,7 @@ http://localhost:8080/ # Backend http://localhost:8080/index.php/admin +_(default account/password used in examples: admin/foobar)_ ``` # Running LimeSurvey with Helm From 9135f556f5d17c161ffef6df5d8569d83e6dc9e8 Mon Sep 17 00:00:00 2001 From: Mark Date: Tue, 5 Sep 2023 13:28:06 -0400 Subject: [PATCH 2/3] Update README.md Fixing previous commit due to forgetting how to format and use Markdown! --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 9688835b0..9288d3f26 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ For further details on the settings see: https://manual.limesurvey.org/Optional_ # 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). +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*. ``` docker-compose up @@ -159,7 +159,6 @@ http://localhost:8080/ # Backend http://localhost:8080/index.php/admin -_(default account/password used in examples: admin/foobar)_ ``` # Running LimeSurvey with Helm From 265b375fc1cd5dd3a09131799b969a5d1685952d Mon Sep 17 00:00:00 2001 From: Mark Date: Wed, 6 Sep 2023 09:57:44 -0400 Subject: [PATCH 3/3] Update README.md 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) --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9288d3f26..8c3157aa6 100644 --- a/README.md +++ b/README.md @@ -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_USERNAME | Database user | | DB_PASSWORD | Database user's password | -| ADMIN_USER | Initial LimeSurvey Admin User | -| ADMIN_NAME | Initial LimeSurvey Admin Username | +| ADMIN_USER | Initial LimeSurvey Admin Username (for signing into admin panel) | +| ADMIN_NAME | Initial LimeSurvey Admin Name | | 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 | | BASE_URL | Application Base URL | | 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 -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 @@ -161,6 +161,8 @@ http://localhost:8080/ 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 A Helm Chart for this Image can be used for deployments. Please refer to the Helm Repository for further details: