Configuration

WARNING

This document is deprecated and no longer maintained, because the graphical configuration panel is available. Some of the content below may be outdated.

• Configuration is optional: Twikoo works without it.
• Make sure the config collection is not publicly readable, otherwise secrets such as your SMTP password may leak.
  The default permissions are safe, so you normally do not need to change anything.
• Store all configuration items in a single record.

General

SITE_NAME

Type: String
Default: null
Required: false
Example: My Blog

Name of the blog or site.

SITE_URL

Type: String
Default: null
Required: false
Example: https://www.example.com

Address of the blog or site.

BLOGGER_EMAIL

Type: String
Default: null
Required: false
Example: 12345@qq.com

Email address of the blogger, used for mail notifications and for the blogger badge.

Anti-spam

AKISMET_KEY

Type: String
Default: null
Required: false
Example: 8651783ed123

API key of the anti-spam comment service.

HIDE_SPAM

Type: String
Default: false
Required: false
Example: true

When set to true, comments marked as spam are hidden from everyone in the front-end comment area, including administrators and the comment author. They remain visible, reviewable and restorable in the admin panel.

WeChat notification

SC_SENDKEY

Type: String
Default: null
Required: false
Example: SCT1364TKdsiGjGvyAZNYDVnuHW12345

SCKEY of the ServerChan WeChat push service.

Mail notification

SENDER_EMAIL

Type: String
Default: null
Required: false
Example: blog@example.com

Sender address of mail notifications. For most mail providers SENDER_EMAIL must be identical to SMTP_USER, otherwise sending fails.

SENDER_NAME

Type: String
Default: null
Required: false
Example: My Blog comment notification

Subject/title of mail notifications.

SMTP_SERVICE

Type: String
Default: null
Required: false
Example: qiye.aliyun

Mail provider used for notifications.
See the full list: Supported services

SMTP_USER

Type: String
Default: null
Required: false
Example: blog@example.com

Username of the mail account.

SMTP_PASS

Type: String
Default: null
Required: false
Example: password

Password of the mail account. For QQ Mail, use the authorization code.