diff --git a/README.md b/README.md index acc0d1d1..525d564a 100644 --- a/README.md +++ b/README.md @@ -347,6 +347,7 @@ release/paopao-ce --no-default-features --features sqlite3,localoss,loggerfile,r |`LoggerMeili` | 日志 | 内测 | 使用[Meilisearch](https://github.com/meilisearch/meilisearch)写日志 | |`Friendship` | 关系模式 | 内测(默认) | 弱关系好友模式,类似微信朋友圈 | |`Followship` | 关系模式 | WIP | 关注者模式,类似Twitter的Follow模式 | +|`Lightship` | 关系模式 | WIP | 开放模式,所有推文都公开可见 | |`Alipay` | 支付 | 稳定 | 开启基于[支付宝开放平台](https://open.alipay.com/)的钱包功能 | |`Sms` | 短信验证 | 稳定 | 开启短信验证码功能,用于手机绑定验证手机是否注册者的;功能如果没有开启,手机绑定时任意短信验证码都可以绑定手机 | |`Docs:OpenAPI` | 开发文档 | 稳定 | 开启openapi文档功能,提供web api文档说明(visit http://127.0.0.1:8008/docs/openapi) | diff --git a/docs/proposal/011-关于Lightship功能项的设计.md b/docs/proposal/011-关于Lightship功能项的设计.md new file mode 100644 index 00000000..fb81beca --- /dev/null +++ b/docs/proposal/011-关于Lightship功能项的设计.md @@ -0,0 +1,40 @@ +| 编号 | 作者 | 发表时间 | 变更时间 | 版本 | 状态 | +| ----- | ----- | ----- | ----- | ----- | ----- | +| 011| 北野 | 2022-12-14 | 2022-12-14 | v1.0 | 提议 | + +### 关于Lightship功能项的设计 +Lightship(开放模式)功能提供完全公开的推文分享服务,有别于[Friendship](002-关于Friendship功能项的设计.md "关于Friendship功能项的设计")、[Followship](003-关于Followship功能项的设计.md "关于Followship功能项的设计"),使用Lightship用户模式部署paopao-ce,用户发布的所有推文都是公开可访问的,广场推文列表展示的是全站所有公开推文的Timeline Tweets。 + +### 场景 +一般用于非常小的站点,或者推文更新不频繁的站点。 +* 推文更新不频繁站点; +* 个人推文站点; +* 单纯想要所有推文公开访问; + +### 需求 +* 广场推文列表只展示公开可访问推文; +* 推文访问权限只能是 `公开/私密`; + +### 方案 + +* 广场推文列表只展示公开可访问推文 - 前端/后端 +* 推文访问权限只能是 `公开/私密` - 前端/后端 + +### 疑问 + +1. 公开模式为什么命名为Lightship? +Lightship有灯塔的意思,灯塔是为航行船只指明方向的公共设施,这里取其公有设施的属性指喻 开放模式下paopao-ce不需要授权公开访问推 文的意思。 +1. 如何开启这个功能? +在配置文件config.yaml中的`Features`中添加`Lightship`功能项开启该功能: +```yaml +... +# features中加上 Lightship +Features: + Default: ["Meili", "LoggerMeili", "Base", "Sqlite3", "BigCacheIndex", "MinIO", "Lightship"] + Base: ["Redis", "PhoneBind"] +... +``` + +### 更新记录 +#### v1.0(2022-12-14) - 北野 +* 初始文档 \ No newline at end of file diff --git a/features-status.md b/features-status.md index 38f8eb6e..082c2f6b 100644 --- a/features-status.md +++ b/features-status.md @@ -133,6 +133,10 @@ * [ ] 提按文档 * [ ] 接口定义 * [ ] 业务逻辑实现 +* `Lightship` 开放模式,所有推文都公开可见(目前状态: WIP); + * [x] 提按文档 + * [ ] 接口定义 + * [ ] 业务逻辑实现 ### 支付: * `Alipay` 开启基于[支付宝开放平台](https://open.alipay.com/)的钱包功能;