Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wuhan005 committed Aug 14, 2024
1 parent d71de15 commit 5946bd5
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 19 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,9 @@ cp conf/app.sample.ini conf/app.ini

## Architecture

![Architecture](./dev/nekobox-arch-light.png#gh-light-mode-only)
![Architecture](./dev/nekobox-arch-dark.png#gh-dark-mode-only)

NekoBox uses GitHub Actions for continuous integration and deployment.

When a user visit NekoBox, the
request will be routed to Aliyun CDN, the CDN access logs will be collected and pushed to Aliyun simple log service
(SLS) in realtime. The log data will be stored in SLS for 180 days for audit purposes.
When a user visit NekoBox, the request will be routed to Cloudflare CDN.

User's profile, questions and answers will be stored in MySQL database.

Expand All @@ -76,15 +71,13 @@ User's session, CSRF token and email verification token will be stored in Redis
The entire request and response chain will be uploaded to Uptrace for debugging purposes. The data will be stored in
Uptrace for 30 days. Administrators can use the `TraceID` provided by users to query the specified request context.

When a user submits a question, the content of the question will be sent to Qiniu text censoring service for review. If
the content is not suitable, the content will then be sent to Aliyun text censoring service for a second review. If the
content still does not pass, the question will be rejected. This is because the Qiniu text censoring service is not very
accurate, some non-offensive content may also be rejected by the Qiniu's service.
When a user submits a question, the content of the question will be sent to Aliyun text censoring service for review. If the
content does not pass, the question will be rejected.

When a user received a new question, an email will be sent to the user's email address by Aliyun mail service (DM).

In the main page, you can check out the changelogs of NekoBox, and you can visit the sponsor page to support NekoBox at
the bottom of the page. The changelogs and sponsor list are stored in a Pocketbase service which is deployed separately.
the bottom of the page. The changelogs and sponsor list are stored in Cloudflare Pages which is deployed separately.

## License

Expand Down
12 changes: 4 additions & 8 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,9 @@ cp conf/app.sample.ini conf/app.ini

## 架构

![Architecture](./dev/nekobox-arch-light.png#gh-light-mode-only)
![Architecture](./dev/nekobox-arch-dark.png#gh-dark-mode-only)

NekoBox 使用 GitHub Actions 进行持续集成和部署。

当用户访问 NekoBox 时,请求将会被发送至阿里云 CDN,CDN 的访问日志将会被实时推送到阿里云日志服务
(SLS)。日志数据将在 SLS 中存储 180 天,用于审计。
当用户访问 NekoBox 时,请求将会被发送至 Cloudflare CDN。

用户的信息、提问和回答将被存储在 MySQL 数据库中。

Expand All @@ -75,13 +71,13 @@ NekoBox 使用 GitHub Actions 进行持续集成和部署。
用户的整个请求和响应链路将被上传到 Uptrace 用于调试。这些数据将被储存 30 天。管理员可以使用用户提供的 `TraceID`
来追踪查询指定的请求。

当用户提交提问时,问题的内容将被发送到七牛文本审查服务进行审查。如果提问内容存在问题,该内容将被发送到阿里云文本审查服务进行二次审查
如果内容审查仍未通过,该提问将被拒绝发送。这是由于七牛文本审查服务不是很准确,一些非冒犯性的内容可能被七牛文本审查误报
当用户提交提问时,问题的内容将被发送到阿里云文本审查服务进行审查
如果内容审查未通过,该提问将被拒绝发送。

当用户收到新的提问时,阿里云邮件服务(DM)会向用户的邮箱发送一封邮件。

你可以在主页查看 NekoBox 的更新日志,也欢迎访问赞助页面来打钱支持 NekoBox。 更新日志和赞助商名单存储在独立部署的
Pocketbase 服务中
Cloudflare Pages 中

## 开源协议

Expand Down
Binary file removed dev/nekobox-arch-dark.png
Binary file not shown.
Binary file removed dev/nekobox-arch-light.png
Binary file not shown.

0 comments on commit 5946bd5

Please sign in to comment.