org1/gitea-pages
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新文档

Browse Source
This commit is contained in:
ExplodingDragon
2025-11-20 23:56:27 +08:00
parent 827f9bd273
commit 651433ff82
2 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,34 +1,32 @@
# gitea-pages # gitea-pages
> Next-generation Gitea Pages, replacing the previous caddy-gitea-proxy > The next generation Gitea Pages, replacing the previous `caddy-gitea-proxy`
**This project is part of Dragon's Zone HomeLab** **This project is part of Dragon's Zone HomeLab**
This project focuses on functional implementation and does not consider any performance optimizations or large-scale 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.
deployment scenarios. Any issues arising from this are not related to the project.
**Note**: The project recently added custom renderers and reverse proxy functionality, which may lead to serious **Note**: This project has been completely refactored and is not compatible with upgrades from version `0.0.1`
security and performance issues. If not needed, it can be turned off in the settings.
## Get Started ## Get Started
Install `go1.25` or later, along with the `Make` tool, and then execute the following command: Install `go1.25` or higher, and also install the `Make` tool, then execute the following command:
```bash ```bash
make gitea-pages make gitea-pages
``` ```
After that, you can start it using the following command: After that, you can start it with the following command:
```bash ```bash
./gitea-pages -conf config.yaml ./gitea-pages -conf config.yaml
``` ```
For specific configurations, check [`config.yaml`](./config.yaml). For specific configurations, see [`config.yaml`](./config.yaml).
### Page Config ### Page Config
Create `.pages.yaml` in the project's `gh-pages` branch and fill in the following content: Create a `.pages.yaml` file in the `gh-pages` branch of your project and fill in the following content:
```yaml ```yaml
alias: # CNAME alias: # CNAME
@@ -46,9 +44,11 @@ routes:
- [x] CNAME custom domains - [x] CNAME custom domains
- [x] Template rendering - [x] Template rendering
- [x] Reverse proxy requests - [x] Reverse proxy requests
- [ ] OAuth2 authorized access to private pages - [ ] Support CORS
- [ ] ~~http01 auto-certificate issuance~~: Handled by Caddy - [ ] Support custom caching strategies (HTTP cache-control)
- [ ] ~~Webhook-triggered updates~~: Not a high priority for real-time needs - [ ] OAuth2 authorization for accessing private pages
- [ ] ~~http01 automatic certificate issuance~~: Handled by Caddy
- [ ] ~~Web hook triggers for updates~~: Not a high priority for real-time needs
## LICENSE ## LICENSE

2
README_zh.md
View File

@@ -6,7 +6,7 @@
本项目的侧重于功能实现，并未考虑任何性能优化，亦未考虑大规模部署的情况，由此带来的任何问题与项目无关。 本项目的侧重于功能实现，并未考虑任何性能优化，亦未考虑大规模部署的情况，由此带来的任何问题与项目无关。
**注意**：项目在最近加入了自定义渲染器和反向代理功能，可能导致严重的安全和性能问题，如不需要可在设置中关闭。 **注意**：此项目已经被完全重构，不兼容 `0.0.1` 版本升级
## Get Started ## Get Started