diff --git a/README.md b/README.md index 87c2eeb0..2edab733 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/README_zh.md b/README_zh.md index 1df6091f..20548b05 100644 --- a/README_zh.md +++ b/README_zh.md @@ -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 ``` diff --git a/docs/skillhub/en/quickstart.md b/docs/skillhub/en/quickstart.md index 3ad6a281..1f2c0289 100644 --- a/docs/skillhub/en/quickstart.md +++ b/docs/skillhub/en/quickstart.md @@ -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 ` | Specify version | `--version v0.2.0` | -| `--aliyun` | Use Alibaba Cloud mirror | `--aliyun` | +| `--aliyun` | Use Alibaba Cloud mirror (recommended for China) | `--aliyun` | | `--home ` | Specify installation directory | `--home /opt/skillhub` | | `--no-scanner` | Disable security scanning service | `--no-scanner` | | `--mirror-registry ` | Custom image registry | `--mirror-registry registry.example.com` | diff --git a/docs/skillhub/quickstart.md b/docs/skillhub/quickstart.md index 070da0e4..f913e85b 100644 --- a/docs/skillhub/quickstart.md +++ b/docs/skillhub/quickstart.md @@ -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 ` | 指定版本 | `--version v0.2.0` | -| `--aliyun` | 使用阿里云镜像 | `--aliyun` | +| `--aliyun` | 使用阿里云镜像（国内推荐） | `--aliyun` | | `--home ` | 指定安装目录 | `--home /opt/skillhub` | | `--no-scanner` | 禁用安全扫描服务 | `--no-scanner` | | `--mirror-registry ` | 自定义镜像仓库 | `--mirror-registry registry.example.com` | diff --git a/scripts/runtime.sh b/scripts/runtime.sh index 4d96eac7..76dc9c93 100755 --- a/scripts/runtime.sh +++ b/scripts/runtime.sh @@ -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 <