From ce0759d0adf58df0beaea73c46839c486b26b9c6 Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniackcrudelis@users.noreply.github.com>
Date: Tue, 31 Mar 2020 23:42:47 +0200
Subject: [PATCH] Update credential.json to version 1.8.0

---
 conf/credentials.json | 33 +++++++++++++++++++++++++++++----
 1 file changed, 29 insertions(+), 4 deletions(-)

diff --git a/conf/credentials.json b/conf/credentials.json
index 80c3c52..02cc320 100644
--- a/conf/credentials.json
+++ b/conf/credentials.json
@@ -2,8 +2,23 @@
   This file must be valid JSON. But comments are allowed
 */
 {
-  //The Type of the database. You can choose between dirty, postgres, sqlite and mysql
-  //You shouldn't use "dirty" for for anything else than testing or development            },
+  /*
+   * The type of the database.
+   *
+   * You can choose between many DB drivers, for example: dirty, postgres,
+   * sqlite, mysql.
+   *
+   * You shouldn't use "dirty" for for anything else than testing or
+   * development.
+   *
+   *
+   * Database specific settings are dependent on dbType, and go in dbSettings.
+   * Remember that since Etherpad 1.6.0 you can also store these informations in
+   * credentials.json.
+   *
+   * For a complete list of the supported drivers, please refer to:
+   * https://www.npmjs.com/package/ueberdb2
+   */
 
   /* An Example of MySQL Configuration */
    "dbType" : "mysql",
@@ -15,10 +30,20 @@
                     "charset" : "utf8mb4"
                   },
 
-  /* Users for basic authentication. is_admin = true gives access to /admin.
-     If you do not uncomment this, /admin will not be available! */
+  /*
+   * Users for basic authentication.
+   *
+   * is_admin = true gives access to /admin.
+   * If you do not uncomment this, /admin will not be available!
+   *
+   * WARNING: passwords should not be stored in plaintext in this file.
+   *          If you want to mitigate this, please install ep_hash_auth and
+   *          follow the section "secure your installation" in README.md
+   */
   "users": {
     "__ADMIN__": {
+      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
+      // 2) please note that if password is null, the user will not be created
       "password": "__PASSWD__",
       "is_admin": true
     }