优化安装过程,新增管理员注册

dependabot/npm_and_yarn/mixin-deep-1.3.2
panjunwen 6 years ago
parent 78672bdbfb
commit a98ecc9244
  1. 138
      README.md

@ -4,57 +4,50 @@ Valine Admin 是 [Valine 评论系统](https://panjunwen.com/diy-a-comment-syste
[评论在线演示及相关功能测试](https://panjunwen.github.io/Valine/)
## 快速部署
安装教程请以博客最新版为准。
### 部署云引擎代码
## 快速部署
1. 在[Leancloud](https://leancloud.cn/dashboard/#/apps)云引擎设置界面,填写代码库并保存:https://github.com/panjunwen/Valine-Admin.git
1. 在[Leancloud](https://leancloud.cn/dashboard/#/apps)云引擎设置界面,填写代码库并保存:https://github.com/panjunwen/Valine-Admin.git
![设置仓库](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-12-56-04.png)
2. 切换到部署标签页,分支使用master,点击部署即可
2. 在设置页面,设置环境变量以及 Web 二级域名。
![一键部署](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-12-56-50.png)
第一次部署需要花点时间。
![部署过程](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-1-00-45.png)
![环境变量](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-3-40-48.png)
3. 在设置页面,输入主机二级域名,该域名用于评论后台管理,如[https://deserts.leanapp.cn](https://deserts.leanapp.cn) ,后台管理登录的用户名密码需要在数据库_User表中自行添加。
![二级域名](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-1-06-41.png)
变量 | 示例 | 说明
--- | ------ | ------
SITE_NAME | Deserts | [必填]博客名称
SITE_URL | https://panjunwen.com | [必填]首页地址
**SMTP_SERVICE** | QQ | [新版支持]邮件服务提供商,支持 QQ、163、126、Gmail 以及 [更多](https://nodemailer.com/smtp/well-known/#supported-services)
SMTP_USER | xxxxxx@qq.com | [必填]SMTP登录用户
SMTP_PASS | ccxxxxxxxxch | [必填]SMTP登录密码(QQ邮箱需要获取独立密码)
SENDER_NAME | Deserts | [必填]发件人
SENDER_EMAIL | xxxxxx@qq.com | [必填]发件邮箱
ADMIN_URL | https://xxx.leanapp.cn/ | [建议]Web主机二级域名,用于自动唤醒
BLOGGER_EMAIL | xxxxx@gmail.com | [可选]博主通知收件地址,默认使用SENDER_EMAIL
4. 在设置页面,设置环境变量
**以上必填参数请务必正确设置。**
![环境变量](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-3-40-48.png)
二级域名用于评论后台管理,如[https://deserts.leanapp.cn](https://deserts.leanapp.cn) 。
![二级域名](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-1-06-41.png)
| 变量 | 示例 | 说明 |
| ------------------- | -------------------------------------------------- | -------------------------------------------- |
| SITE_NAME | Deserts | [必填]博客名称 |
| SITE_URL | https://panjunwen.com | [必填]首页地址 |
| SMTP_SERVICE | QQ | [重要]如果没有您的服务商,请填入自定义邮件配置(见下文) |
| SMTP_HOST | smtp.qq.com | [自定义]SMTP服务器地址 |
| SMTP_PORT | 465 | [自定义]SMTP端口 |
| SMTP_SECURE | ture | SMTP加密,默认为true
| SMTP_USER | xxxxxx@qq.com | [自定义]SMTP登录用户 |
| SMTP_PASS | ccxxxxxxxxch | [自定义]SMTP登录密码(QQ邮箱需要获取独立密码) |
| SENDER_NAME | Deserts | [必填]发件人 |
| SENDER_EMAIL | xxxxxx@qq.com | [必填]发件邮箱 |
| BLOGGER_EMAIL | xxxxx@gmail.com | 博主通知收件地址 |
| MAIL_SUBJECT | ${PARENT_NICK},您在${SITE_NAME}上的评论收到了回复 | @通知邮件主题(标题)模板 |
| MAIL_TEMPLATE | 见下文 | @通知邮件内容模板 |
| MAIL_SUBJECT_ADMIN | ${SITE_NAME}上有新评论了 | 博主邮件通知主题模板 |
| MAIL_TEMPLATE_ADMIN | 见下文 | 博主邮件通知内容模板 |
| ADMIN_URL | https://xxx.leanapp.cn/ | Web主机二级域名,用于自动唤醒 |
| AKISMET_KEY | xxxxxxxxxxxx | Akismet Key 用于垃圾评论检测(见下文) |
3. 切换到部署标签页,分支使用master,点击部署即可
![一键部署](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-12-56-50.png)
**SMTP_SERVICE** :邮件服务提供商,支持 QQ、163、126、Gmail、Yahoo、...... ,全部支持请参考 : ![Nodemailer Supported services](https://nodemailer.com/smtp/well-known/#supported-services)。 --- 如这里没有你使用的邮件提供商,请自定义邮件服务器
第一次部署需要花点时间。
**以上必填参数请务必全部设置**,方能保证通知邮件正确发送。
![部署过程](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-1-00-45.png)
5. 定时任务设置
4. 评论管理。访问设置的二级域名`https://二级域名.leanapp.cn/sign-up`,设置管理员登录信息,如:[https://deserts.leanapp.cn/sign-up](https://deserts.leanapp.cn/sign-up)
<img src="https://cloud.panjunwen.com/2018/10/ping-mu-kuai-zhao-2018-10-22-xia-wu-9-35-51.png" alt="管理员注册" style="
width: 600px;">
5. 定时任务设置
目前实现了两种云函数定时任务:(1)自动唤醒,定时访问Web APP二级域名防止云引擎休眠;(2)每天定时检查24小时内漏发的邮件通知。
@ -62,18 +55,34 @@ Valine Admin 是 [Valine 评论系统](https://panjunwen.com/diy-a-comment-syste
选择self-wake云函数,Cron表达式为`0 0/30 7-23 * * ?`,表示每天早6点到晚23点每隔30分钟访问云引擎,`ADMIN_URL`环境变量务必设置正确:
![唤醒云引擎](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-18-xia-wu-2-57-43.png)
<img src="https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-18-xia-wu-2-57-43.png" alt="唤醒云引擎" style="
width: 600px;">
选择resend-mails云函数,Cron表达式为`0 0 8 * * ?`,表示每天早8点检查过去24小时内漏发的通知邮件并补发:
![通知检查](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-18-xia-wu-2-57-53.png)
<img src="https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-18-xia-wu-2-57-53.png" alt="通知检查" style="
width: 600px;
">
**添加定时器后记得点击启动方可生效。**
## 更多设置
### 评论管理
评论管理页仍然比较简单,在评论量较低时基本满足需要。
![评论管理](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-19-xia-wu-8-12-51.png)
### 邮件通知模板
邮件通知模板在云引擎环境变量中设定,可自定义通知邮件标题及内容模板。
环境变量 | 示例 | 说明
--- | ------ | ------
MAIL_SUBJECT | ${PARENT_NICK},您在${SITE_NAME}上的评论收到了回复 | [可选]@通知邮件主题(标题)模板
MAIL_TEMPLATE | 见下文 | [可选]@通知邮件内容模板
MAIL_SUBJECT_ADMIN | ${SITE_NAME}上有新评论了 | [可选]博主邮件通知主题模板
MAIL_TEMPLATE_ADMIN | 见下文 | [可选]博主邮件通知内容模板
邮件通知包含两种,分别是被@通知和博主通知,这两种模板都可以完全自定义。默认使用经典的蓝色风格模板(样式来源未知)。
默认被@通知邮件内容模板如下:
@ -88,15 +97,15 @@ Valine Admin 是 [Valine 评论系统](https://panjunwen.com/diy-a-comment-syste
@通知模板中的可用变量如下(注,这是邮件模板变量,请勿与云引擎环境变量混淆):
| 变量 | 说明 |
| -------------- | ------------------------------- |
| SITE_NAME | 博客名称 |
| SITE_URL | 博客首页地址 |
| POST_URL | 文章地址(完整路径) |
| PARENT_NICK | 收件人昵称(被@者,父级评论人) |
| PARENT_COMMENT | 父级评论内容 |
| NICK | 新评论者昵称 |
| COMMENT | 新评论内容 |
模板变量 | 说明
----|----
SITE_NAME | 博客名称
SITE_URL | 博客首页地址
POST_URL | 文章地址(完整路径)
PARENT_NICK | 收件人昵称(被@者,父级评论人)
PARENT_COMMENT | 父级评论内容
NICK | 新评论者昵称
COMMENT | 新评论内容
默认博主通知邮件内容模板如下:
@ -117,13 +126,8 @@ Valine Admin 是 [Valine 评论系统](https://panjunwen.com/diy-a-comment-syste
![彩虹模板](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-5-17-21.png)
和一个彩虹风格的博主通知模板代码:
```html
<div style="border-radius: 10px 10px 10px 10px;font-size:13px; color: #555555;width: 666px;font-family:'Century Gothic','Trebuchet MS','Hiragino Sans GB',微软雅黑,'Microsoft Yahei',Tahoma,Helvetica,Arial,'SimSun',sans-serif;margin:50px auto;border:1px solid #eee;max-width:100%;background: #ffffff repeating-linear-gradient(-45deg,#fff,#fff 1.125rem,transparent 1.125rem,transparent 2.25rem);box-shadow: 0 1px 5px rgba(0, 0, 0, 0.15);"> <div style="width:100%;background:#49BDAD;color:#ffffff;border-radius: 10px 10px 0 0;background-image: -moz-linear-gradient(0deg, rgb(67, 198, 184), rgb(255, 209, 244));background-image: -webkit-linear-gradient(0deg, rgb(67, 198, 184), rgb(255, 209, 244));height: 66px;"> <p style="font-size:15px;word-break:break-all;padding: 23px 32px;margin:0;background-color: hsla(0,0%,100%,.4);border-radius: 10px 10px 0 0;">您的<a style="text-decoration:none;color: #ffffff;" href="${SITE_URL}"> ${SITE_NAME} </a>上有新的评论啦! </p> </div> <div style="margin:40px auto;width:90%"> <p>${NICK} 发表评论:</p> <div style="background: #fafafa repeating-linear-gradient(-45deg,#fff,#fff 1.125rem,transparent 1.125rem,transparent 2.25rem);box-shadow: 0 2px 5px rgba(0, 0, 0, 0.15);margin:20px 0px;padding:15px;border-radius:5px;font-size:14px;color:#555555;">${COMMENT}</div> <p><a style="text-decoration:none; color:#12addb" href="${POST_URL}" target="_blank">[查看评论]</a></p> <style type="text/css">a:link{text-decoration:none}a:visited{text-decoration:none}a:hover{text-decoration:none}a:active{text-decoration:none}</style> </div> </div>
```
### 垃圾评论检测
## 垃圾评论检测
> Akismet (Automattic Kismet)是应用广泛的一个垃圾留言过滤系统,其作者是大名鼎鼎的WordPress 创始人 Matt Mullenweg,Akismet也是WordPress默认安装的插件,其使用非常广泛,设计目标便是帮助博客网站来过滤留言Spam。有了Akismet之后,基本上不用担心垃圾留言的烦恼了。
> 启用Akismet后,当博客再收到留言会自动将其提交到Akismet并与Akismet上的黑名单进行比对,如果名列该黑名单中,则该条留言会被标记为垃圾评论且不会发布。
@ -134,29 +138,25 @@ Valine Admin 是 [Valine 评论系统](https://panjunwen.com/diy-a-comment-syste
**如果使用了本站最新的Valine和Valine Admin,并设置了Akismet Key,可以有效地拦截垃圾评论。被标为垃圾的评论可以在管理页面取消标注。**
### 防止云引擎休眠
环境变量 | 示例 | 说明
--- | ------ | ------
AKISMET_KEY | xxxxxxxxxxxx | [可选]Akismet Key 用于垃圾评论检测
## 防止云引擎休眠
关于自动休眠的官方说法:[点击查看](https://leancloud.cn/docs/leanengine_plan.html#hash633315134)
目前最新版的 Valine Admin 已经可以实现自唤醒,即在 LeanCloud 云引擎中定时请求 Web 应用地址防止休眠。对于夜间休眠期漏发的邮件通知,自动在次日早上补发。**务必确保配置中设置了ADMIN_URL环境变量,并在第5步添加了两个云函数定时任务。**
### 评论管理
评论管理页仍然比较简单,在评论量较低时基本满足需要。
![评论管理](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-19-xia-wu-8-12-51.png)
### Troubleshooting
## Troubleshooting
- 部署失败,请在评论中附图,或去Github发起Issue
- 邮件发送失败,确保环境变量都没问题后,重启云引擎
![重启云引擎](https://cloud.panjunwen.com/2018/09/ping-mu-kuai-zhao-2018-09-15-xia-wu-5-22-56.png)
- 博主通知模板中不要出现`PARENT*`相关参数(请勿混用模板)
- 进入Valine Admin评论管理界面,需要在Leancloud数据库中手动新建用户名密码
- 点击邮件中的链接跳转至相应评论,这一细节实现需要一点额外的代码:
``` javascript
@ -172,6 +172,14 @@ Valine Admin 是 [Valine 评论系统](https://panjunwen.com/diy-a-comment-syste
</script>
```
- 自定义邮件服务器地址和端口信息,删除SMTP_SERVICE环境变量,新增以下变量:
变量 | 示例 | 说明
----|------|------
SMTP_HOST | smtp.qq.com | [可选]SMTP_SERVICE留空时,自定义SMTP服务器地址
SMTP_PORT | 465 | [可选]SMTP_SERVICE留空时,自定义SMTP端口
SMTP_SECURE | true | [可选]SMTP_SERVICE留空时填写
## 相关项目
评论框前端:[Valine on Github](https://github.com/panjunwen/Valine)

Loading…
Cancel
Save