From 44766755d8b3d0c6e0c218633ec6316a6e642f0c Mon Sep 17 00:00:00 2001 From: ChuNa7a Date: Thu, 15 Oct 2026 22:58:13 +0800 Subject: [PATCH] docs: add ChuRepo download and source installation alternatives --- .github/workflows/release.yml | 4 ++++ README.md | 20 ++++++++++++++++++ docs/install.md | 40 +++++++++++++++++++++++++++++++++-- 3 files changed, 62 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index de1e182..64a1f87 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -9,6 +9,10 @@ # 装的人拿到的就是编好的二进制,不需要 GHC / Rust: # curl -fsSL https://raw.githubusercontent.com/TheBadRoger/ChuSQL/main/scripts/install.sh \ # | sh -s -- --component web +# 也可下载 ChuRepo 脚本(发行包仍默认取自 GitHub): +# curl -fsSL https://repo.chunana.cn/ChuNa7a/ChuSQL/raw/branch/main/scripts/install.sh -o install.sh +# sh install.sh --component web +# 两站发行包与源码安装入口见 docs/install.md。 # 没有对应平台的资源时,同一个脚本可以退回本地编译: # sh scripts/install.sh --component web --from-source # diff --git a/README.md b/README.md index 83b1ad5..e22932f 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ ChuSQL 是采用 Haskell SQL 引擎与 Rust 存储层的数据库项目,提供 TCP 服务、CLI 和 Web 管理端。支持查询优化、快照事务、WAL 崩溃恢复、DOMAIN 自定义类型及用户与角色管理。 +项目仓库:[GitHub](https://github.com/TheBadRoger/ChuSQL) · [ChuRepo](https://repo.chunana.cn/ChuNa7a/ChuSQL)。两处均可获取源码,按网络情况选择。 + ## 快速开始 ### 安装 @@ -21,6 +23,15 @@ Linux / macOS: curl -fsSL https://raw.githubusercontent.com/TheBadRoger/ChuSQL/main/scripts/install.sh | sh -s -- --component web ``` +也可从 ChuRepo 下载后执行: + +```sh +curl -fsSL \ + https://repo.chunana.cn/ChuNa7a/ChuSQL/raw/branch/main/scripts/install.sh \ + -o install.sh +sh install.sh --component web +``` + Windows(PowerShell 里下下来再跑;也有下载 zip 解压的包内安装): ```powershell @@ -28,6 +39,15 @@ irm https://raw.githubusercontent.com/TheBadRoger/ChuSQL/main/scripts/install.ps & "$env:TEMP\install.ps1" -Component web ``` +ChuRepo 下载方式: + +```powershell +irm https://repo.chunana.cn/ChuNa7a/ChuSQL/raw/branch/main/scripts/install.ps1 -OutFile "$env:TEMP\install.ps1" +& "$env:TEMP\install.ps1" -Component web +``` + +以上在线安装脚本默认从 GitHub 获取发行包,脚本下载来源不会改变发行包来源。GitHub 不可用时,参见[包内安装](docs/install.md#包内安装)或[从源码安装](docs/install.md#从源码安装)。 + ### 启动 ```sh diff --git a/docs/install.md b/docs/install.md index 2bddc78..d03cbed 100644 --- a/docs/install.md +++ b/docs/install.md @@ -6,6 +6,8 @@ 发行包已经包含编译后的程序,普通用户安装时无需安装 GHC 或 Rust 工具链。 +项目仓库:[GitHub](https://github.com/TheBadRoger/ChuSQL) · [ChuRepo](https://repo.chunana.cn/ChuNa7a/ChuSQL)。两处均可获取源码,按网络情况选择。 + ## 在线安装 Linux / macOS: @@ -14,6 +16,15 @@ Linux / macOS: curl -fsSL https://raw.githubusercontent.com/TheBadRoger/ChuSQL/main/scripts/install.sh | sh -s -- --component web ``` +也可从 ChuRepo 下载后执行: + +```sh +curl -fsSL \ + https://repo.chunana.cn/ChuNa7a/ChuSQL/raw/branch/main/scripts/install.sh \ + -o install.sh +sh install.sh --component web +``` + Windows PowerShell: ```powershell @@ -21,6 +32,15 @@ irm https://raw.githubusercontent.com/TheBadRoger/ChuSQL/main/scripts/install.ps & "$env:TEMP\install.ps1" -Component web ``` +ChuRepo 下载方式: + +```powershell +irm https://repo.chunana.cn/ChuNa7a/ChuSQL/raw/branch/main/scripts/install.ps1 -OutFile "$env:TEMP\install.ps1" +& "$env:TEMP\install.ps1" -Component web +``` + +以上在线安装脚本默认从 GitHub 获取发行包,脚本下载来源不会改变发行包来源。GitHub 不可用时,参见[包内安装](#包内安装)或[从源码安装](#从源码安装)。 + ## 安装方式 ChuSQL 支持三种安装方式: @@ -52,7 +72,9 @@ journalctl --user -u chusql-server.service ## 包内安装 -解压发行包后,在包根目录执行: +发行包入口:[GitHub Releases](https://github.com/TheBadRoger/ChuSQL/releases) · [ChuRepo Releases](https://repo.chunana.cn/ChuNa7a/ChuSQL/releases)。两站的发行包需分别发布;若所选站点没有对应版本或平台的包,请切换站点或从源码安装。 + +下载并解压对应平台的发行包后,在包根目录执行;包内安装不需要连接发行站点: ```sh ./install.sh --component web @@ -84,10 +106,24 @@ Windows: 源码安装需要 `git`、`cargo`、`stack` 和 `ghc`;部分 Linux 环境还需要 zlib 开发包。 +选择一个源码地址克隆(只需执行其中一条): + ```sh -./install.sh --component web --from-source +# GitHub +git clone https://github.com/TheBadRoger/ChuSQL.git +# 或 ChuRepo +git clone https://repo.chunana.cn/ChuNa7a/ChuSQL.git ``` +Linux 进入仓库后使用本地源码构建,避免再次连接 GitHub 克隆: + +```sh +cd ChuSQL +sh scripts/install.sh --component web --from-source --source-dir . +``` + +`--from-source` 当前构建流程面向 Linux;Windows / macOS 优先使用对应平台发行包。 + 源码构建完成后的配置、初始化和启动流程与发行包安装一致。 ## 安装完成后