更新默认配置和使用说明

This commit is contained in:
dragon
2025-01-10 17:28:18 +08:00
parent 7a936f35bc
commit b505b6a5fb
2 changed files with 41 additions and 4 deletions

View File

@@ -6,18 +6,30 @@
本项目的侧重于功能实现,并未考虑任何性能优化,亦未考虑大规模部署的情况,由此带来的任何问题与项目无关。
## Feature
## Get Started
- [x] 内容缓存
- [x] CNAME 自定义域名
安装 `go1.23` 或更高版本,同时安装 `Make` 工具 ,然后执行如下命令:
```bash
make gitea-pages
```
之后可使用如下命令启动
```bash
./gitea-pages -conf config.yaml
```
具体配置可查看 [`config.yaml`](./config.yaml)。
## TODO
- [x] 内容缓存
- [x] CNAME 自定义域名
- [ ] OAuth2 授权访问私有页面
- [ ] ~~http01 自动签发证书~~: 交由 Caddy 完成
- [ ] ~~Web 钩子触发更新~~: 对实时性需求不大
## LICENSE
此项目使用 [Apache-2.0](./LICENSE)