diff --git a/README.md b/README.md index 6a3c3d8..6c88d70 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,32 @@ # 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 focuses on functional implementation and does not consider any performance optimizations or large-scale -deployment scenarios. Any issues arising from this are not related to the project. +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. -**Note**: The project recently added custom renderers and reverse proxy functionality, which may lead to serious -security and performance issues. If not needed, it can be turned off in the settings. +**Note**: This project has been completely refactored and is not compatible with upgrades from version `0.0.1` ## 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 make gitea-pages ``` -After that, you can start it using the following command: +After that, you can start it with the following command: ```bash ./gitea-pages -conf config.yaml ``` -For specific configurations, check [`config.yaml`](./config.yaml). +For specific configurations, see [`config.yaml`](./config.yaml). ### 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 alias: # CNAME @@ -46,9 +44,11 @@ routes: - [x] CNAME custom domains - [x] Template rendering - [x] Reverse proxy requests -- [ ] OAuth2 authorized access to private pages -- [ ] ~~http01 auto-certificate issuance~~: Handled by Caddy -- [ ] ~~Webhook-triggered updates~~: Not a high priority for real-time needs +- [ ] Support CORS +- [ ] Support custom caching strategies (HTTP cache-control) +- [ ] 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 diff --git a/README_zh.md b/README_zh.md index 2bafeb2..26733d0 100644 --- a/README_zh.md +++ b/README_zh.md @@ -6,7 +6,7 @@ 本项目的侧重于功能实现,并未考虑任何性能优化,亦未考虑大规模部署的情况,由此带来的任何问题与项目无关。 -**注意**:项目在最近加入了自定义渲染器和反向代理功能,可能导致严重的安全和性能问题,如不需要可在设置中关闭。 +**注意**:此项目已经被完全重构,不兼容 `0.0.1` 版本升级 ## Get Started