docs: simplify runtime script usage (#217)

* docs: simplify runtime script usage

Unify to use runtime.sh for all deployment commands, removing the
distinction between "official images" and "Aliyun mirror". The --aliyun
parameter is preserved for users in China to specify the mirror.

Changes:
- Remove runtime-github.sh references, use runtime.sh uniformly
- Default command uses GHCR images
- Add --aliyun parameter for China users
- Update README.md, README_zh.md, and docs/skillhub/ quickstart files

* docs: consolidate documentation links with clear descriptions

Merge the two documentation links into a single "Documentation" section
with clear descriptions of each:
- User Guide: skill publishing, search, CLI usage
- Developer Docs: architecture, API reference, deployment

This makes it easier for users to find the right documentation.

* docs: consolidate documentation links with clear descriptions

Merge the two documentation links into a single "Documentation" section
with clear descriptions of each:
- User Guide: skill publishing, search, CLI usage
- Developer Docs: architecture, API reference, deployment

This makes it easier for users to find the right documentation.

* fix: include --home parameter in shutdown command

When starting with a custom --home directory, the generated shutdown
command now includes the same --home parameter to ensure it can find
the correct compose files.
This commit is contained in:
XiaoSeS 2026-04-02 20:59:49 +08:00 committed by GitHub
parent 612b69c2f9
commit 37c25c3f91
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 39 additions and 44 deletions

View file

@ -30,7 +30,10 @@ it to a namespace, and let others find it through search or
install it via CLI. Built for on-premise deployment behind your
firewall, with the same polish you'd expect from a public registry.
📖 **[Full Documentation →](https://zread.ai/iflytek/skillhub)**
## Documentation
- 📖 **[User Guide](https://iflytek.github.io/skillhub/)** — Skill publishing, search, CLI usage and other user guides
- 🛠️ **[Developer Docs](https://zread.ai/iflytek/skillhub)** — Architecture, API reference, local development, deployment and operations
## Highlights
@ -65,35 +68,30 @@ firewall, with the same polish you'd expect from a public registry.
## Quick Start
📖 **[User Documentation →](https://iflytek.github.io/skillhub/)**
Start the full local stack with:
Start the full local stack with one of the following commands:
Official images:
```bash
rm -rf /tmp/skillhub-runtime
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime-github.sh | sh -s -- up
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up
```
The default command pulls the `latest` stable release images. Use
`--version edge` if you want the newest build from `main`.
The default command pulls the `latest` stable release images. Use `--version edge` if you want the newest build from `main`.
**Configure public URL (recommended for production):**
```bash
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime-github.sh | sh -s -- up --public-url https://skillhub.your-company.com
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --public-url https://skillhub.your-company.com
```
The `--public-url` parameter sets the public access URL for your SkillHub instance.
This ensures:
The `--public-url` parameter sets the public access URL for your SkillHub instance. This ensures:
- CLI install commands show the correct registry URL
- Agent setup instructions display the correct skill.md URL
- OAuth callbacks and device auth links work properly
Aliyun mirror shortcut:
**For users in China (Aliyun mirror):**
```bash
rm -rf /tmp/skillhub-aliyun
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --home /tmp/skillhub-aliyun --aliyun --version latest --public-url https://skillhub.your-company.com
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --aliyun --public-url https://skillhub.your-company.com
```
If deployment runs into problems, clear the existing runtime home and retry.
@ -187,8 +185,8 @@ Published images target both `linux/amd64` and `linux/arm64`.
**Quick deployment with curl:**
```bash
# Official images
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime-github.sh | sh -s -- up --public-url https://skillhub.your-company.com
# Default (GHCR images)
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --public-url https://skillhub.your-company.com
# Aliyun mirror (recommended for users in China)
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --aliyun --public-url https://skillhub.your-company.com

View file

@ -19,7 +19,10 @@
SkillHub 是一个自托管平台,为团队提供私有的、受治理的智能体技能共享空间。发布技能包,推送到命名空间,让其他人通过搜索发现或通过 CLI 安装。专为防火墙后的本地部署而构建,提供与公共注册中心相同的精致体验。
📖 **[完整文档 →](https://zread.ai/iflytek/skillhub)**
## 文档
- 📖 **[用户指南](https://iflytek.github.io/skillhub/)** — 技能发布、搜索、CLI 使用等用户操作指南
- 🛠️ **[开发者文档](https://zread.ai/iflytek/skillhub)** — 架构设计、API 参考、本地开发、部署运维等技术文档
## 核心特性
@ -37,23 +40,19 @@ SkillHub 是一个自托管平台,为团队提供私有的、受治理的智
## 快速开始
📖 **[用户使用文档 →](https://iflytek.github.io/skillhub/)**
使用以下命令启动完整的本地环境:
使用以下命令之一启动完整的本地环境:
官方镜像:
```bash
rm -rf /tmp/skillhub-runtime
curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/scripts/runtime.sh | sh -s -- up
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up
```
默认命令会拉取 `latest` 稳定版镜像;如果你想跟随 `main`
的最新构建,请显式传 `--version edge`
默认命令会拉取 `latest` 稳定版镜像;如果你想跟随 `main` 的最新构建,请显式传 `--version edge`
**配置公网访问地址(生产环境推荐):**
```bash
curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/scripts/runtime.sh | sh -s -- up --public-url https://skillhub.your-company.com
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --public-url https://skillhub.your-company.com
```
`--public-url` 参数用于设置 SkillHub 实例的公网访问地址。配置后:
@ -61,10 +60,10 @@ curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/scripts/runti
- Agent 设置指引会显示正确的 skill.md URL
- OAuth 回调和设备认证链接能正常工作
阿里云镜像快捷方式:
**国内用户(阿里云镜像):**
```bash
rm -rf /tmp/skillhub-aliyun
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --home /tmp/skillhub-aliyun --aliyun --version latest --public-url https://skillhub.your-company.com
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --aliyun --public-url https://skillhub.your-company.com
```
如果部署遇到问题,请清除现有的运行时目录并重试。
@ -100,11 +99,7 @@ curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- u
### 停止服务
```bash
# 使用官方镜像
/tmp/skillhub-runtime/runtime.sh down
# 使用阿里云镜像
/tmp/skillhub-aliyun/runtime.sh down
```
## 开发
@ -172,10 +167,10 @@ skillhub/
### 使用 Docker Compose
```bash
# 使用官方镜像
curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/scripts/runtime.sh | sh -s -- up --public-url https://skillhub.your-company.com
# 默认GHCR 镜像)
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --public-url https://skillhub.your-company.com
# 使用阿里云镜像
# 阿里云镜像(国内推荐)
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --aliyun --public-url https://skillhub.your-company.com
```

View file

@ -4,12 +4,11 @@
Use the curl command to quickly deploy SkillHub (includes all services: Web UI, Backend API, PostgreSQL, Redis, MinIO, Skill Scanner):
**Official images (recommended)**:
```bash
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime-github.sh | sh -s -- up
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up
```
**Alibaba Cloud mirror** (recommended for users in China):
**For users in China (Alibaba Cloud mirror)**:
```bash
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --aliyun
```
@ -26,7 +25,7 @@ curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- u
| Parameter | Description | Example |
|-----------|-------------|---------|
| `--version <tag>` | Specify version | `--version v0.2.0` |
| `--aliyun` | Use Alibaba Cloud mirror | `--aliyun` |
| `--aliyun` | Use Alibaba Cloud mirror (recommended for China) | `--aliyun` |
| `--home <dir>` | Specify installation directory | `--home /opt/skillhub` |
| `--no-scanner` | Disable security scanning service | `--no-scanner` |
| `--mirror-registry <url>` | Custom image registry | `--mirror-registry registry.example.com` |

View file

@ -4,12 +4,11 @@
使用 curl 命令快速部署 SkillHub包含所有服务Web UI、Backend API、PostgreSQL、Redis、MinIO、Skill Scanner
**官方镜像(推荐)**
```bash
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime-github.sh | sh -s -- up
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up
```
**阿里云镜像**(国内用户推荐):
**国内用户(阿里云镜像):**
```bash
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --aliyun
```
@ -26,7 +25,7 @@ curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- u
| 参数 | 说明 | 示例 |
|------|------|------|
| `--version <tag>` | 指定版本 | `--version v0.2.0` |
| `--aliyun` | 使用阿里云镜像 | `--aliyun` |
| `--aliyun` | 使用阿里云镜像(国内推荐) | `--aliyun` |
| `--home <dir>` | 指定安装目录 | `--home /opt/skillhub` |
| `--no-scanner` | 禁用安全扫描服务 | `--no-scanner` |
| `--mirror-registry <url>` | 自定义镜像仓库 | `--mirror-registry registry.example.com` |

View file

@ -233,13 +233,17 @@ case "$COMMAND" in
run_compose up -d
fi
PUBLIC_URL="${SKILLHUB_PUBLIC_BASE_URL_VALUE:-http://localhost}"
HOME_ARG=""
if [ "$SKILLHUB_HOME" != "$SKILLHUB_HOME_DEFAULT" ]; then
HOME_ARG=" --home $SKILLHUB_HOME"
fi
cat <<EOF
SkillHub runtime started.
Web UI: $PUBLIC_URL
Backend API: http://localhost:8080
Runtime dir: $SKILLHUB_HOME
Stop with:
curl -fsSL $SKILLHUB_RAW_BASE/scripts/runtime.sh | sh -s -- down
curl -fsSL $SKILLHUB_RAW_BASE/scripts/runtime.sh | sh -s -- down$HOME_ARG
EOF
;;
down)