diff --git a/README.md b/README.md index 6c88d70..6aff7e6 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,21 @@ **This project is part of Dragon's Zone HomeLab** -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. +This project focuses on providing a high-performance, secure, and extensible Gitea Pages service. **Note**: This project has been completely refactored and is not compatible with upgrades from version `0.0.1` +## Features + +- [x] **High Performance**: Optimized JS execution with program caching and efficient promise handling. +- [x] **Secure**: Built-in path traversal protection for template and file access. +- [x] **Content Caching**: Multi-level caching for metadata and blob content. +- [x] **CNAME**: Support for custom domains. +- [x] **Template Engine**: Secure template rendering with include support. +- [x] **Programmable**: Extensible logic using JavaScript (Goja). +- [x] **Reverse Proxy**: Support for proxying requests to backends. + + ## Get Started Install `go1.25` or higher, and also install the `Make` tool, then execute the following command: @@ -40,10 +51,6 @@ routes: ## TODO -- [x] Content caching -- [x] CNAME custom domains -- [x] Template rendering -- [x] Reverse proxy requests - [ ] Support CORS - [ ] Support custom caching strategies (HTTP cache-control) - [ ] OAuth2 authorization for accessing private pages diff --git a/README_zh.md b/README_zh.md index 26733d0..dbe2de8 100644 --- a/README_zh.md +++ b/README_zh.md @@ -4,10 +4,21 @@ **此项目是 Dragon's Zone HomeLab 的一部分** -本项目的侧重于功能实现,并未考虑任何性能优化,亦未考虑大规模部署的情况,由此带来的任何问题与项目无关。 +本项目致力于提供高性能、安全且可扩展的 Gitea Pages 服务。 **注意**:此项目已经被完全重构,不兼容 `0.0.1` 版本升级 +## 特性 + +- [x] **高性能**: 采用 JS 预编译缓存和高效的异步 Promise 处理机制。 +- [x] **安全**: 内置模板和文件访问的路径穿越保护。 +- [x] **内容缓存**: 多级元数据和二进制内容缓存。 +- [x] **CNAME**: 支持自定义域名。 +- [x] **模板引擎**: 安全的模板渲染,支持 `load` 动态加载。 +- [x] **可编程**: 使用 JavaScript (Goja) 编写自定义路由逻辑。 +- [x] **反向代理**: 支持将请求代理到后端服务。 + + ## Get Started 安装 `go1.25` 或更高版本,同时安装 `Make` 工具 ,然后执行如下命令: @@ -40,10 +51,6 @@ routes: ## TODO -- [x] 内容缓存 -- [x] CNAME 自定义域名 -- [x] 模板渲染 -- [x] 反向代理请求 - [ ] 支持跨域 - [ ] 支持自定义缓存策略 (http cache-control) - [ ] OAuth2 授权访问私有页面