Skip to content

Commit bcd7f42

Browse files
marove2000lafriks
authored andcommitted
Added quoting for passwords in sample.app.ini and documentation (#3395)
1 parent b627f11 commit bcd7f42

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

custom/conf/app.ini.sample

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@ DB_TYPE = mysql
198198
HOST = 127.0.0.1:3306
199199
NAME = gitea
200200
USER = root
201+
; Use PASSWD = `your password` for quoting if you use special characters in the password.
201202
PASSWD =
202203
; For "postgres" only, either "disable", "require" or "verify-full"
203204
SSL_MODE = disable
@@ -342,6 +343,7 @@ KEY_FILE = custom/mailer/key.pem
342343
FROM =
343344
; Mailer user name and password
344345
USER =
346+
; Use PASSWD = `your password` for quoting if you use special characters in the password.
345347
PASSWD =
346348
; Send mails as plain text
347349
SEND_AS_PLAIN_TEXT = false
@@ -464,6 +466,7 @@ SUBJECT = Diagnostic message from server
464466
HOST =
465467
; Mailer user name and password
466468
USER =
469+
; Use PASSWD = `your password` for quoting if you use special characters in the password.
467470
PASSWD =
468471
; Receivers, can be one or more, e.g. [email protected],[email protected]
469472
RECEIVERS =

docs/content/doc/advanced/config-cheat-sheet.en-us.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
118118
- `HOST`: **127.0.0.1:3306**: Database host address and port.
119119
- `NAME`: **gitea**: Database name.
120120
- `USER`: **root**: Database username.
121-
- `PASSWD`: **\<empty\>**: Database user password.
121+
- `PASSWD`: **\<empty\>**: Database user password. Use \`your password\` for quoting if you use special characters in the password.
122122
- `SSL_MODE`: **disable**: For PostgreSQL only.
123123
- `PATH`: **data/gitea.db**: For SQLite3 only, the database file path.
124124

@@ -185,7 +185,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
185185
- `FROM`: **\<empty\>**: Mail from address, RFC 5322. This can be just an email address, or
186186
the "Name" \<[email protected]\> format.
187187
- `USER`: **\<empty\>**: Username of mailing user (usually the sender's e-mail address).
188-
- `PASSWD`: **\<empty\>**: Password of mailing user.
188+
- `PASSWD`: **\<empty\>**: Password of mailing user. Use \`your password\` for quoting if you use special characters in the password.
189189
- `SKIP_VERIFY`: **\<empty\>**: Do not verify the self-signed certificates.
190190
- **Note:** Gitea only supports SMTP with STARTTLS.
191191
- `USE_SENDMAIL`: **false** Use the operating system's `sendmail` command instead of SMTP.

0 commit comments

Comments
 (0)