服务端环境变量

大约 6 分钟...

你可以通过下面的环境变量对 Waline 服务端进行配置。

注意

环境变量在更新后必须重新部署才能生效。

Vercel 需要在 Settings - Environment Variables 中进行设置。

主要配置

环境变量名称必填备注
LEAN_IDLeanCloud 应用的 App ID
LEAN_KEYLeanCloud 应用的 App Key
LEAN_MASTER_KEYLeanCloud 应用的 Master Key 用于后台修改数据
LEAN_SERVERLeanCloud 服务地址,国内版用户需要配置此项
SITE_NAME博客名称
SITE_URL博客地址
LOGIN当设置为 LOGIN=force 时会要求登录才能评论

显示

环境变量名称默认值备注
DISABLE_USERAGENTfalse是否隐藏评论者的 UA,默认为否
DISABLE_REGIONfalse是否隐藏评论者的归属地
DISABLE_AUTHOR_NOTIFYfalse是否禁止新评论通知
AVATAR_PROXYhttps://avatar.75cdn.workers.dev头像的代理地址,设置 false 关闭代理
GRAVATAR_STRhttps://seccdn.libravatar.org/avatar/{{mail|md5}}Gravatar 头像的地址,基于 nunjucks 语法
LEVELS设置后会根据评论数为每个用户提供等级标签

等级标签

根据设置的等级条件以及用户的评论数,会为评论者增加等级标签。该功能默认关闭,可以通过配置环境变量 LEVELS 开启该功能。配置的形式为一串给定的数的逗号拼接,例如 0,10,20,50,100,200 表示的就是:

等级条件默认等级标签
00 <= count < 10潜水
110 <= count < 20冒泡
220 <= count < 50吐槽
350 <= count < 100活跃
4100 <= count < 200话痨
5200 <= count传说

除了可以自定义等级判断规则之外,我们还可以在客户端自定义等级标签,详见 等级标签

默认只提供了 6 级文案,但并不表示只能有 6 个级别。具体的等级上限是根据你设置的等级判断规则来的。增加新的等级建议自己配置上等级对应的文案,没有提供文案的话默认展示的就是 Level 10 这样的默认文案。

安全

环境变量名称默认值备注
IPQPS60基于 IP 的评论发布频率限制,单位为秒。设置为 0 不限制
SECURE_DOMAINS安全域名配置,支持逗号分隔配置多个域名
AKISMET_KEY70542d86693eAkismet 反垃圾评论服务 Key (默认开启,不用请设置为 false)
COMMENT_AUDITfalse评论发布审核开关。开启后评论需要经过管理员审核后才能显示,所以建议在评论框默认文字上提供提示
RECAPTCHA_V3_KEYreCAPTCHA V3 key,须与客户端同时配置
RECAPTCHA_V3_SECRETreCAPTCHA V3 secret,服务端使用,不可泄漏

Recaptcha

Recaptcha Key 和 Secret 可在 https://www.google.com/recaptchaopen in new window 申请。

配置时安全域名需要同时添加网站地址和 Waline 服务端地址。

Markdown

环境变量名称默认值备注
MARKDOWN_CONFIG{}MarkdownIt 配置
MARKDOWN_HIGHLIGHTtrue是否启用高亮
MARKDOWN_EMOJItrue是否启用 Emoji 缩写支持
MARKDOWN_SUBtrue是否启用下角标支持
MARKDOWN_SUPtrue是否启用上角标支持
MARKDOWN_TEXmathjax解析 Tex 的服务,支持 mathjaxkatexfalse
MARKDOWN_MATHJAX{}MathJax 选项
MARKDOWN_KATEX{}Katex 选项

邮件

用户注册和评论的邮件通知都会用到邮件服务。配置邮件服务相关变量后,用户注册会增加邮箱验证码确认相关的操作,用来防止恶意的注册。

环境变量名称备注
SMTP_SERVICESMTP 邮件发送服务提供商
SMTP_HOSTSMTP 服务器地址
SMTP_PORTSMTP 服务器端口。
SMTP_USERSMTP 用户名
SMTP_PASSSMTP 密码
SMTP_SECURE是否使用 SSL 连接 SMTP
SENDER_NAME自定义发送邮件的发件人
SENDER_EMAIL自定义发送邮件的发件地址

提示

可以在 这里open in new window 查看支持的服务商。SMTP_SERVICE 和 (SMTP_HOSTSMTP_PORT) 任选其一即可,如果没有在列表中知道对应的 SMTP_SERVICE 的话则需要配 SMTP_HOSTSMTP_PORT,它们一般可以在邮箱的设置中找到。

SMTP 的用户名通常均支持用户的完整邮箱,而密码大多同邮箱密码。

请特别注意部分邮箱 (如 163、qq 邮箱) 使用单独的 SMTP 密码。

数据库

MongoDB

环境变量名称必填默认值备注
MONGO_DBMongoDB 数据库名称
MONGO_USERMongoDB 服务的用户名
MONGO_PASSWORDMongoDB 服务的密码
MONGO_HOST127.0.0.1MongoDB 服务的地址,支持数组格式
MONGO_PORT27017MongoDB 服务的端口,支持数组格式
MONGO_REPLICASETMongoDB 集群
MONGO_AUTHSOURCEMongoDB 认证源
MONGO_OPT_SSLfalse是否使用 SSL 进行连接

MySQL

环境变量名称必填默认值备注
MYSQL_DBMySQL 数据库库名
MYSQL_USERMySQL 数据库的用户名
MYSQL_PASSWORDMySQL 数据库的密码
MYSQL_HOST127.0.0.1MySQL 服务的地址
MYSQL_PORT3306MySQL 服务的端口
MYSQL_PREFIXwl_MySQL 数据表的表前缀
MYSQL_CHARSETutf8mb4MySQL 数据表的字符集
MYSQL_SSLfalse是否使用 SSL MYSQL 连接数据库

TiDB

在 TiDB 上创建数据库

环境变量名称必填默认值备注
TIDB_DBTiDB 数据库库名
TIDB_USERTiDB 数据库的用户名
TIDB_PASSWORDTiDB 数据库的密码
TIDB_HOST127.0.0.1TiDB 服务的地址
TIDB_PORT4000TiDB 服务的端口
TIDB_PREFIXwl_TiDB 数据表的表前缀
TIDB_CHARSETutf8mb4TiDB 数据表的字符集

SQLite

环境变量名称必填默认值备注
SQLITE_PATHSQLite 数据库文件的路径,该路径不包含文件名本身
JWT_TOKEN用户登录密钥,随机字符串即可
SQLITE_DBwalineSQLite 数据库文件名,若文件名变化需要修改该字段值
SQLITE_PREFIXwl_SQLite 数据表的表前缀

PostgreSQL

环境变量名称必填默认值备注
PG_DBPostgreSQL 数据库库名
PG_USERPostgreSQL 数据库的用户名
PG_PASSWORDPostgreSQL 数据库的密码
PG_HOST127.0.0.1PostgreSQL 服务的地址
PG_PORT3211PostgreSQL 服务的端口
PG_PREFIXwl_PostgreSQL 数据表的表前缀
PG_SSLfalse是否使用 SSL 连接 PostgreSQL 数据库

CloudBase

环境变量名称必填默认值备注
TCB_ENV腾讯云开发环境 ID
TCB_ID腾讯云 API 密钥 ID
TCB_KEY腾讯云 API 密钥 Key
JWT_TOKEN用户登录密钥,如果没有配任何环境变量的话需要配置此变量,随机字符串即可

提示

对于腾讯云 API 密钥 ID 与 Key,可以在 此处open in new window 申请。

GitHub

环境变量名称必填默认值备注
GITHUB_TOKENPersonal access tokensopen in new window
GITHUB_REPO仓库名称,例如 walinejs/waline
GITHUB_PATH数据存储目录,例如 data 表示存储在 data 目录下,默认存在仓库根目录下

Deta Base

环境变量名称必填默认值备注
DETA_PROJECT_KEYDeta 项目密钥

高级配置

环境变量名称默认值备注
OAUTH_URLhttps://oauth.lithub.ccOAuth 第三方登录服务地址,可以 自建 authopen in new window 这是能让用户使用 GitHub, Twitter, Facebook, Google, 微博等第三方账户登录最简单的方式。
WEBHOOK评论成功后会向 WEBHOOK 配置的地址发送一条 POST 请求
WALINE_ADMIN_MODULE_ASSET_URL//unpkg.com/@waline/adminWaline admin 地址
友情提示:评论区仅作评论展示,如有问题咨询请去 Github Discussion 中提问。
你认为这篇文章怎么样?
  • 0
  • 0
  • 0
  • 0
  • 0
  • 0
评论
  • 按正序
  • 按倒序
  • 按热度
Powered by Waline v2.14.7