From bcd7f42529d0d35268b1130afa3d9330b0779d6b Mon Sep 17 00:00:00 2001
From: Timo Schindler <timo.schindler87@googlemail.com>
Date: Sat, 27 Jan 2018 19:35:49 +0100
Subject: [PATCH] Added quoting for passwords in sample.app.ini and
documentation (#3395)
---
custom/conf/app.ini.sample | 3 +++
docs/content/doc/advanced/config-cheat-sheet.en-us.md | 4 ++--
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/custom/conf/app.ini.sample b/custom/conf/app.ini.sample
index a931ca4eaa..9bfa841b73 100644
--- a/custom/conf/app.ini.sample
+++ b/custom/conf/app.ini.sample
@@ -198,6 +198,7 @@ DB_TYPE = mysql
HOST = 127.0.0.1:3306
NAME = gitea
USER = root
+; Use PASSWD = `your password` for quoting if you use special characters in the password.
PASSWD =
; For "postgres" only, either "disable", "require" or "verify-full"
SSL_MODE = disable
@@ -342,6 +343,7 @@ KEY_FILE = custom/mailer/key.pem
FROM =
; Mailer user name and password
USER =
+; Use PASSWD = `your password` for quoting if you use special characters in the password.
PASSWD =
; Send mails as plain text
SEND_AS_PLAIN_TEXT = false
@@ -464,6 +466,7 @@ SUBJECT = Diagnostic message from server
HOST =
; Mailer user name and password
USER =
+; Use PASSWD = `your password` for quoting if you use special characters in the password.
PASSWD =
; Receivers, can be one or more, e.g. 1@example.com,2@example.com
RECEIVERS =
diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
index 941e08a7ea..6f3a51c58c 100644
--- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md
+++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
@@ -118,7 +118,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
- `HOST`: **127.0.0.1:3306**: Database host address and port.
- `NAME`: **gitea**: Database name.
- `USER`: **root**: Database username.
-- `PASSWD`: **\<empty\>**: Database user password.
+- `PASSWD`: **\<empty\>**: Database user password. Use \`your password\` for quoting if you use special characters in the password.
- `SSL_MODE`: **disable**: For PostgreSQL only.
- `PATH`: **data/gitea.db**: For SQLite3 only, the database file path.
@@ -185,7 +185,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
- `FROM`: **\<empty\>**: Mail from address, RFC 5322. This can be just an email address, or
the "Name" \<email@example.com\> format.
- `USER`: **\<empty\>**: Username of mailing user (usually the sender's e-mail address).
-- `PASSWD`: **\<empty\>**: Password of mailing user.
+- `PASSWD`: **\<empty\>**: Password of mailing user. Use \`your password\` for quoting if you use special characters in the password.
- `SKIP_VERIFY`: **\<empty\>**: Do not verify the self-signed certificates.
- **Note:** Gitea only supports SMTP with STARTTLS.
- `USE_SENDMAIL`: **false** Use the operating system's `sendmail` command instead of SMTP.