Skip to content

Commit ff05800

Browse files
committed
docs: update initial release notes
1 parent a31214c commit ff05800

1 file changed

Lines changed: 36 additions & 9 deletions

File tree

docs/release-notes.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
11
# SubBoost v2.4.0
22

3-
## Highlights
3+
## 中文
44

5-
- Publishes SubBoost from a clean release repository with fresh public Git history.
6-
- Keeps the AGPL-3.0-only public source, local deployment app, shared packages, and release workflow together in the canonical `SubBoost/subboost` repository.
7-
- Ships the current local deployment experience, shared parser/generator logic, template tools, rule management UI, and self-host release assets as one cohesive source snapshot.
8-
- Keeps the one-click deployment assets available through the release: `install.sh`, `release.json`, `docker-compose.image.yml`, and `subboost-manager`.
5+
### 初始发布
96

10-
## Upgrade Notes
7+
这是 SubBoost 的首次公开发布。这个版本提供一个可以自行部署的 SubBoost 包,适合希望在自己的服务器上运行 SubBoost,并管理订阅转换、模板和规则配置的用户。
118

12-
- No manual migration is required for existing deployments.
13-
- Existing deployments can keep using the normal `subboost update` flow.
14-
- The repository is temporarily kept private while final rollout validation finishes.
9+
### 包含内容
10+
11+
- 一键部署脚本和 Docker Compose 配置,用于在 Linux 服务器上安装 SubBoost。
12+
- 本地 Web 管理界面,用于创建管理员账号,并管理订阅、模板和规则。
13+
- 共享的订阅解析、订阅生成、模板处理和规则处理能力。
14+
- GitHub Release 资产:`install.sh``release.json``docker-compose.image.yml``subboost-manager`
15+
- 基于 AGPL-3.0-only 许可证发布的公开源码。
16+
17+
### 安装和更新
18+
19+
- 这是首次发布,新安装不需要人工迁移。
20+
- 安装后,后续版本可以继续使用 `subboost update` 更新。
21+
- 建议妥善保存 `/opt/subboost/.env` 和数据库备份,方便以后迁移或恢复。
22+
23+
## English
24+
25+
### Initial Release
26+
27+
This is the first public release of SubBoost. This version provides a self-hostable SubBoost package for users who want to run SubBoost on their own server and manage subscription conversion, templates, and rule configuration.
28+
29+
### What's Included
30+
31+
- A one-click deployment script and Docker Compose configuration for installing SubBoost on a Linux server.
32+
- A local web management interface for creating an administrator account and managing subscriptions, templates, and rules.
33+
- Shared subscription parsing, subscription generation, template processing, and rule processing capabilities.
34+
- GitHub Release assets: `install.sh`, `release.json`, `docker-compose.image.yml`, and `subboost-manager`.
35+
- Public source code released under the AGPL-3.0-only license.
36+
37+
### Installation and Updates
38+
39+
- This is the first release, so new installations do not require manual migration.
40+
- After installation, future versions can continue to be updated with `subboost update`.
41+
- Keep `/opt/subboost/.env` and database backups safe so future migration or recovery is easier.

0 commit comments

Comments
 (0)