k2safe/orbit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: publish Orbit image reference and Compose pull instructions

Browse Source
This commit is contained in:
k2safe
2026-11-02 15:41:30 +08:00
parent 9df5ffec74
commit 7ce4cce24f
3 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -206,9 +206,17 @@ fmt.Println(current.ID, current.State)
## Docker 与域名部署 ## Docker 与域名部署
Orbit 服务端镜像在 OmniGate 公开发布，可匿名拉取；同一标签支持 Linux AMD64 和 ARM64：
```sh
docker pull api.omnigate.site/platform/orbit:v0.1.3
```
镜像包含 Orbit 服务、迁移和管理工具；首次部署还需要 MySQL。按[Compose 首次启动说明](docs/22-compose-deployment.md#2-首次启动)配置数据库和管理员。服务端镜像、Go SDK、Outbox 适配包分别版本化。
本机给其他服务联调，可直接运行 `./scripts/orbit-local.py up`，自动部署到 `18080`，生成管理员和 SDK 配置；完整地址、Docker 网络与启停方法见[本地 Compose 测试环境](deploy/local/README.md)。 本机给其他服务联调，可直接运行 `./scripts/orbit-local.py up`，自动部署到 `18080`，生成管理员和 SDK 配置；完整地址、Docker 网络与启停方法见[本地 Compose 测试环境](deploy/local/README.md)。
仓库提供 [Dockerfile](Dockerfile)、[Compose 启动链](deploy/docker-compose.yml)和 [Nginx 配置](deploy/nginx/orbit.conf.example)。按[完整 Compose 手册](docs/22-compose-deployment.md)注入数据库密码、构建镜像、启动 MySQL/迁移/核验、初始化管理员，最后启动 Orbit。手册也包括停止、更新与两节点覆盖配置。 仓库提供 [Dockerfile](Dockerfile)、[Compose 启动链](deploy/docker-compose.yml)和 [Nginx 配置](deploy/nginx/orbit.conf.example)。按[完整 Compose 手册](docs/22-compose-deployment.md)注入数据库密码、选择镜像、启动 MySQL/迁移/核验、初始化管理员，最后启动 Orbit。手册也包括停止、更新与两节点覆盖配置。
- Console 同源访问：域名反向代理到 Orbit 后，页面自动使用这个域名，无需在界面填写服务地址。 - Console 同源访问：域名反向代理到 Orbit 后，页面自动使用这个域名，无需在界面填写服务地址。
- 业务 SDK：把自己的 `baseURL` / 示例 `ORBIT_URL` 配置为该 HTTPS 域名，SDK 使用相应 WSS 地址。 - 业务 SDK：把自己的 `baseURL` / 示例 `ORBIT_URL` 配置为该 HTTPS 域名，SDK 使用相应 WSS 地址。

6
docs/08-development-plan.md
View File

@@ -360,3 +360,9 @@ A04派发已提交而消息尚未到达Worker的精确进程故障已通过[专
- [x] 复用现有 Orbit 品牌图形，增加 SVG 和 16/32/48 像素 ICO 图标，登录页与管理端共用。 - [x] 复用现有 Orbit 品牌图形，增加 SVG 和 16/32/48 像素 ICO 图标，登录页与管理端共用。
- [x] `make test vet build docs-check` 通过；本地部署修订 `d47d0d361d7edbcadf5728013cebcf1a2b908cc7`。未登录可请求两种图标，HTTP 200、媒体类型与文件内容正确；登录页与实际控制台均引用图标，readiness 为 ready。 - [x] `make test vet build docs-check` 通过；本地部署修订 `d47d0d361d7edbcadf5728013cebcf1a2b908cc7`。未登录可请求两种图标，HTTP 200、媒体类型与文件内容正确；登录页与实际控制台均引用图标，readiness 为 ready。
## 2026-11-02：Orbit 服务端双架构镜像
- [x] OmniGate 创建公开应用运行仓库 `platform/orbit`；修正 Dockerfile，按 BuildKit 的目标架构交叉编译。
- [x] `v0.1.3` 镜像以提交 `9df5ffec74674413835a0de5a38ab6417c8952b7` 为源，两个架构的三项 ELF 已逐项核对；分别运行 `orbit-admin release manifest` 验证版本、提交及 Schema 35。
- [x] 已发布 `api.omnigate.site/platform/orbit:v0.1.3`，远端索引 `sha256:7a58bdb6fa9f39dc4eb7f80dc46300627043a2284ed565787e71bf5d033bb390`。撤销临时写入凭据后，以空 Docker 登录配置在两个平台分别拉取并运行，发布清单与本地逐项一致。独立 Compose 项目以此摘要和空库启动，迁移、权限、核验和 readiness 均成功；服务返回版本 v0.1.3 和预期提交。详见[部署说明](22-compose-deployment.md)。

12
docs/22-compose-deployment.md
View File

@@ -20,20 +20,18 @@ Compose 文件要求显式提供数据库密码，仓库没有默认密码，也
## 2. 首次启动 ## 2. 首次启动
先构建不可变镜像。正式发布时应把 `ORBIT_IMAGE` 换成带版本和摘要的镜像地址： 从项目根目录运行。可以直接使用已发布的公开服务端镜像，无需登录 OmniGate 或重新编译。Docker 按主机自动选择 `linux/amd64` 或 `linux/arm64`。以下示例固定到 v0.1.3 的双架构索引摘要；如需单独构建，见[容器构建说明](21-container-deployment.md)。
```sh ```sh
docker build \ export ORBIT_IMAGE=api.omnigate.site/platform/orbit:v0.1.3@sha256:7a58bdb6fa9f39dc4eb7f80dc46300627043a2284ed565787e71bf5d033bb390
--build-arg VERSION=v0.1.1 \ docker pull "$ORBIT_IMAGE"
--build-arg REVISION="$(git rev-parse HEAD)" \ # 无需数据库即可核对镜像版本、源码提交及内置迁移清单
--build-arg BUILD_TIME="$(date -u +%Y-%m-%dT%H:%M:%SZ)" \ docker run --rm --entrypoint /usr/local/bin/orbit-admin "$ORBIT_IMAGE" release manifest
-t orbit:v0.1.1 .
``` ```
在当前 shell 或 Secret 管理器中注入配置。以下值仅是变量示例，不是生产密码： 在当前 shell 或 Secret 管理器中注入配置。以下值仅是变量示例，不是生产密码：
```sh ```sh
export ORBIT_IMAGE=orbit:v0.1.1
export ORBIT_DB_NAME=orbit export ORBIT_DB_NAME=orbit
export ORBIT_DB_USER=orbit_runtime export ORBIT_DB_USER=orbit_runtime
export ORBIT_DB_PASSWORD='从秘密管理器读取' export ORBIT_DB_PASSWORD='从秘密管理器读取'