diff --git a/apps/starvpn/README.md b/apps/starvpn/README.md new file mode 100644 index 0000000..93fb406 --- /dev/null +++ b/apps/starvpn/README.md @@ -0,0 +1,43 @@ +# StarVPN + +StarVPN 是一款简单易用的自托管 VPN 服务,支持多平台和 Docker 快速部署,适合个人和团队安全上网。 + +## 主要功能 +- 支持多平台客户端接入 +- 简单易用的 Web 管理界面 +- 支持账号密码登录 +- 支持 Docker 一键部署 +- 高性能、安全稳定 + +## 快速部署(Docker 示例) +```yaml +version: "3" +services: + starvpn: + image: starvpn/starvpn:latest + container_name: starvpn + environment: + - STARS_USER=admin # 管理员账号 + - STARS_PASS=admin # 管理员密码 + ports: + - "8080:8080" # Web 管理端口 + volumes: + - ./starvpn-data:/data + restart: always +``` + +## 参数说明 +- **STARS_USER**:Web 管理员账号 +- **STARS_PASS**:Web 管理员密码 +- **8080**:Web 管理端口 +- **/data**:数据持久化目录 + +## 常见问题 FAQ +- 默认账号密码为 admin/admin,建议首次部署后及时修改。 +- 支持多平台客户端,详见官方文档。 +- 如需自定义端口或目录,请修改 compose 文件对应参数。 + +## 官方文档与支持 +- 官网:[https://starvpn.cn/](https://starvpn.cn/) +- 文档:[https://doc.starvpn.cn/#/docker](https://doc.starvpn.cn/#/docker) +- GitHub:[https://github.com/starvpn/starvpn](https://github.com/starvpn/starvpn) \ No newline at end of file diff --git a/apps/starvpn/README_en.md b/apps/starvpn/README_en.md new file mode 100644 index 0000000..9a08b76 --- /dev/null +++ b/apps/starvpn/README_en.md @@ -0,0 +1,43 @@ +# StarVPN + +StarVPN is an easy-to-use self-hosted VPN service, supporting multi-platform and Docker quick deployment, suitable for personal and team secure networking. + +## Main Features +- Multi-platform client support +- Simple web management UI +- Account/password login +- One-click Docker deployment +- High performance, secure and stable + +## Quick Deployment (Docker Example) +```yaml +version: "3" +services: + starvpn: + image: starvpn/starvpn:latest + container_name: starvpn + environment: + - STARS_USER=xxxxx # User username + - STARS_PASS=xxxxx # User password + ports: + - "8080:8080" # Web management port + volumes: + - ./starvpn-data:/data + restart: always +``` + +## Parameter Description +- **STARS_USER**: username +- **STARS_PASS**: password +- **8080**: Web management port +- **/data**: Data persistence directory + +## FAQ +- Default username/password is admin/admin. Please change it after first deployment. +- Multi-platform clients supported, see official docs. +- To customize port or directory, edit the compose file accordingly. + +## Official Docs & Support +- Website: [https://starvpn.cn/](https://starvpn.cn/) +- Docs: [https://doc.starvpn.cn/#/docker](https://doc.starvpn.cn/#/docker) +- GitHub: [https://github.com/starvpn/starvpn](https://github.com/starvpn/starvpn) \ No newline at end of file diff --git a/apps/starvpn/data.yml b/apps/starvpn/data.yml new file mode 100644 index 0000000..9e877ad --- /dev/null +++ b/apps/starvpn/data.yml @@ -0,0 +1,37 @@ +name: StarVPN + +tags: + - VPN + - 网络工具 + - 代理 + - Docker + - 跨平台 +title: 简单易用的自托管 VPN 服务 + +description: StarVPN 是一款支持多平台的自托管 VPN 服务,支持 Docker 快速部署,适合个人和团队安全上网。 + +additionalProperties: + key: starvpn + name: StarVPN + tags: + - VPN + - Network + - Proxy + - Docker + - CrossPlatform + shortDescZh: 简单易用的自托管 VPN 服务,支持多平台。 + shortDescEn: Easy-to-use self-hosted VPN service, cross-platform supported. + description: + en: Easy-to-use self-hosted VPN service. Supports Docker quick deployment, suitable for personal and team secure networking. + zh: StarVPN 是一款支持多平台的自托管 VPN 服务,支持 Docker 快速部署,适合个人和团队安全上网。 + type: website + crossVersionUpdate: true + limit: 0 + recommend: 0 + website: https://starvpn.cn/ + github: https://github.com/starvpn/starvpn + document: https://doc.starvpn.cn/#/docker + architectures: + - amd64 + - arm64 + - arm/v7 \ No newline at end of file diff --git a/apps/starvpn/latest/data.yml b/apps/starvpn/latest/data.yml new file mode 100644 index 0000000..121c4f9 --- /dev/null +++ b/apps/starvpn/latest/data.yml @@ -0,0 +1,31 @@ +additionalProperties: + formFields: + - default: user + edit: true + envKey: STARS_USER + labelEn: User User + labelZh: 成员账号 + required: true + type: string + - default: password + edit: true + envKey: STARS_PASS + labelEn: User Password + labelZh: 成员密码 + required: true + type: string + - default: 8080 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Web Port + labelZh: 管理端口 + required: true + rule: paramPort + type: number + - default: ./starvpn-data + edit: true + envKey: STARVPN_DATA_PATH + labelEn: Data Path + labelZh: 数据目录 + required: true + type: string \ No newline at end of file diff --git a/apps/starvpn/latest/docker-compose.yml b/apps/starvpn/latest/docker-compose.yml new file mode 100644 index 0000000..e1e7aa4 --- /dev/null +++ b/apps/starvpn/latest/docker-compose.yml @@ -0,0 +1,12 @@ +services: + starvpn: + image: starvpn/starvpn:latest + container_name: starvpn + restart: always + environment: + - STARS_USER=${STARS_USER} + - STARS_PASS=${STARS_PASS} + ports: + - "${PANEL_APP_PORT_HTTP}:8080" + volumes: + - "./starvpn-data:/data" \ No newline at end of file diff --git a/apps/starvpn/logo.png b/apps/starvpn/logo.png new file mode 100644 index 0000000..262044f Binary files /dev/null and b/apps/starvpn/logo.png differ