From 8468ef03dad3fb50cae4380490904dc9e37ede72 Mon Sep 17 00:00:00 2001 From: Menci Date: Tue, 6 Nov 2018 21:32:20 +0800 Subject: [PATCH] Update README --- README.en.md | 54 +++++----------------------------------------------- README.md | 54 +++++----------------------------------------------- 2 files changed, 10 insertions(+), 98 deletions(-) diff --git a/README.en.md b/README.en.md index 44d5be3..b37d6ee 100644 --- a/README.en.md +++ b/README.en.md @@ -7,6 +7,11 @@ This project is the **official** successor and rewritten version of the original Currently maintained by [LibreOJ](https://loj.ac). +# Deploying +Currently, the tutorial for deploying is only available in Chinese. It's [部署指南](https://github.com/syzoj/syzoj/wiki/%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97) in this project's wiki. + +Join QQ group [565280992](https://jq.qq.com/?_wv=1027&k=5JQZWwd) or Telegram group [@lojdev](https://t.me/lojdev) for help. + # Upgrading Because of updates to the database structure, users who upgrade from a commit BEFORE [d5bcbe8fb79e80f9d603b764ac787295cceffa34](https://github.com/syzoj/syzoj/commit/d5bcbe8fb79e80f9d603b764ac787295cceffa34) (Feb 21, 2018) **MUST** perform the following SQL on the database. @@ -32,52 +37,3 @@ Who upgraded from a commit BEFORE [84b9e2d7b51e4ed3ab426621b66cf5ae9e1e1c23](htt ```sql ALTER TABLE `problem` ADD `publicize_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP AFTER `type`; ``` - -# Deploying -Currently, the tutorial for deploying is only available in Chinese. It's [SYZOJ 部署指南](https://github.com/syzoj/syzoj/wiki/SYZOJ-%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97) in this project's wiki. - -Join QQ group [565280992](https://jq.qq.com/?_wv=1027&k=5JQZWwd) or Telegram group [@lojdev](https://t.me/lojdev) for help. - -## Email Configuration -### register_mail -Whether to enable register mail verification. - -### email\_jwt\_secret -Secret used for email token, **for security** please fill with random string. - -### email -#### Sendmail(often fail, not recommended) -```js - "email": { - "method": "sendmail", - "options": { - "address": "sender@address.domain", - } - }, -``` - -#### Aliyun Direct Mail(recommended) -```js - "email": { - "method": "aliyundm", - "options": { - "AccessKeyId": "xxxx", - "AccessKeySecret": "xxxx", - "AccountName": "sender@address.domain" - } - }, -``` - -#### SMTP -```js - "email": { - "method": "smtp", - "options": { - "host": "smtp.163.com", - "port": 465, - "username": "xxx@163.com", - "password": "xxx", - "allowUnauthorizedTls": false - } - }, -``` diff --git a/README.md b/README.md index ad3991c..68ee5c4 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,11 @@ 目前由 [LibreOJ](https://loj.ac) 维护。 +# 部署 +见本项目 Wiki 中的 [部署指南](https://github.com/syzoj/syzoj/wiki/%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97)。 + +加入 QQ 群 [565280992](https://jq.qq.com/?_wv=1027&k=5JQZWwd) 或 Telegram 群 [@lojdev](https://t.me/lojdev) 以取得帮助。 + # 升级须知 因为一些数据库结构的更新,从该 commit [d5bcbe8fb79e80f9d603b764ac787295cceffa34](https://github.com/syzoj/syzoj/commit/d5bcbe8fb79e80f9d603b764ac787295cceffa34)(2018 年 4 月 21 日)前更新的用户**必须**在其数据库上执行以下 SQL 语句。 @@ -32,52 +37,3 @@ ALTER TABLE `judge_state` CHANGE `result` `result` JSON NOT NULL; ```sql ALTER TABLE `problem` ADD `publicize_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP AFTER `type`; ``` - -# 部署 -见本项目 Wiki 中的 [SYZOJ 部署指南](https://github.com/syzoj/syzoj/wiki/SYZOJ-%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97)。 - -加入 QQ 群 [565280992](https://jq.qq.com/?_wv=1027&k=5JQZWwd) 或 Telegram 群 [@lojdev](https://t.me/lojdev) 以取得帮助。 - -## 邮箱配置 -### register_mail -是否启用注册邮件验证。 - -### email\_jwt\_secret -用于邮件令牌签名的密钥,为了安全起见,请使用随机字符串填写。 - -### email -#### Sendmail(成功率低,不推荐) -```js - "email": { - "method": "sendmail", - "options": { - "address": "sender@address.domain", - } - }, -``` - -#### 阿里云邮件推送服务(成功率高,推荐) -```js - "email": { - "method": "aliyundm", - "options": { - "AccessKeyId": "xxxx", - "AccessKeySecret": "xxxx", - "AccountName": "sender@address.domain" - } - }, -``` - -#### SMTP -```js - "email": { - "method": "smtp", - "options": { - "host": "smtp.163.com", - "port": 465, - "username": "xxx@163.com", - "password": "xxx", - "allowUnauthorizedTls": false - } - }, -```