Skip to content

Commit 651433f

Browse files
更新文档
1 parent 827f9bd commit 651433f

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,32 @@
11
# gitea-pages
22

3-
> Next-generation Gitea Pages, replacing the previous caddy-gitea-proxy
3+
> The next generation Gitea Pages, replacing the previous `caddy-gitea-proxy`
44
55
**This project is part of Dragon's Zone HomeLab**
66

7-
This project focuses on functional implementation and does not consider any performance optimizations or large-scale
8-
deployment scenarios. Any issues arising from this are not related to the project.
7+
This project focuses on functionality implementation and does not consider any performance optimizations or large-scale deployment scenarios. Any issues arising from this are not related to the project.
98

10-
**Note**: The project recently added custom renderers and reverse proxy functionality, which may lead to serious
11-
security and performance issues. If not needed, it can be turned off in the settings.
9+
**Note**: This project has been completely refactored and is not compatible with upgrades from version `0.0.1`
1210

1311
## Get Started
1412

15-
Install `go1.25` or later, along with the `Make` tool, and then execute the following command:
13+
Install `go1.25` or higher, and also install the `Make` tool, then execute the following command:
1614

1715
```bash
1816
make gitea-pages
1917
```
2018

21-
After that, you can start it using the following command:
19+
After that, you can start it with the following command:
2220

2321
```bash
2422
./gitea-pages -conf config.yaml
2523
```
2624

27-
For specific configurations, check [`config.yaml`](./config.yaml).
25+
For specific configurations, see [`config.yaml`](./config.yaml).
2826

2927
### Page Config
3028

31-
Create `.pages.yaml` in the project's `gh-pages` branch and fill in the following content:
29+
Create a `.pages.yaml` file in the `gh-pages` branch of your project and fill in the following content:
3230

3331
```yaml
3432
alias: # CNAME
@@ -46,9 +44,11 @@ routes:
4644
- [x] CNAME custom domains
4745
- [x] Template rendering
4846
- [x] Reverse proxy requests
49-
- [ ] OAuth2 authorized access to private pages
50-
- [ ] ~~http01 auto-certificate issuance~~: Handled by Caddy
51-
- [ ] ~~Webhook-triggered updates~~: Not a high priority for real-time needs
47+
- [ ] Support CORS
48+
- [ ] Support custom caching strategies (HTTP cache-control)
49+
- [ ] OAuth2 authorization for accessing private pages
50+
- [ ] ~~http01 automatic certificate issuance~~: Handled by Caddy
51+
- [ ] ~~Web hook triggers for updates~~: Not a high priority for real-time needs
5252
5353
## LICENSE
5454

README_zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
本项目的侧重于功能实现,并未考虑任何性能优化,亦未考虑大规模部署的情况,由此带来的任何问题与项目无关。
88

9-
**注意**项目在最近加入了自定义渲染器和反向代理功能,可能导致严重的安全和性能问题,如不需要可在设置中关闭。
9+
**注意**此项目已经被完全重构,不兼容 `0.0.1` 版本升级
1010

1111
## Get Started
1212

0 commit comments

Comments
 (0)