Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fghrsh authored Nov 3, 2021
1 parent 7d60184 commit a47655d
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ A simple social groups compatible with ActivityPub.
- 单个群组 Actor 支持自定义修改
- 个人资料页 头像、横幅、昵称
- 中文简介、英文简介、简介模板
- Push 任务队列,自动重试
- Shared Inbox、Outbox 实现
- 跨站消息 HTTP Signature 校验
- 兼容 Mastodon、Misskey、Pleroma

### 待实现
- Outbox 任务队列
- 私信修改 Actor 信息
- RsaSignature2017 生成

Expand All @@ -32,17 +32,24 @@ A simple social groups compatible with ActivityPub.
### 环境要求
- MySQL 数据库
- PHP 版本 >= 7.0
- 依赖 PHP 扩展:curl, json, pdo_mysql
- 依赖 PHP 扩展:curl, json, pcntl, pdo_mysql

### 安装步骤
1. 编辑 `config.php` 参数
2. 导入 `tools/wxwclub.sql` 数据表
3. 重写请求至 `index.php`,例如Nginx
3. 重写请求至 `index.php`,例如 Nginx:
```
location / {
try_files $uri $uri/ /index.php$is_args$args;
}
```
4. 运行 `wxwClub worker`,推荐 Docker:
```
1. cd wxwClub/
2. docker build -t 'wxwclub:worker' .
3. docker run -d --restart always -v $(pwd):/wxwClub \
--name wxwclub_worker wxwclub:worker php /wxwClub/cli.php worker
```

## 版权声明

Expand Down

0 comments on commit a47655d

Please sign in to comment.