2026-10-03 02:17:46 +08:00
# 安装与卸载
2026-10-13 14:09:36 +08:00
[← 返回 README ](../README.md )
**本页导航：** [在线安装 ](#在线安装 ) · [安装方式 ](#安装方式 ) · [包内安装 ](#包内安装 ) · [常用安装选项 ](#常用安装选项 ) · [从源码安装 ](#从源码安装 ) · [安装完成后 ](#安装完成后 ) · [更新 ](#更新 ) · [卸载 ](#卸载 ) · [发布校验 ](#发布校验 )
2026-10-03 02:17:46 +08:00
发行包已经包含编译后的程序，普通用户安装时无需安装 GHC 或 Rust 工具链。
2026-10-15 22:58:13 +08:00
项目仓库：[GitHub ](https://github.com/TheBadRoger/ChuSQL ) · [ChuRepo ](https://repo.chunana.cn/ChuNa7a/ChuSQL )。两处均可获取源码，按网络情况选择。
2026-10-03 02:17:46 +08:00
## 在线安装
Linux / macOS：
```sh
curl -fsSL https://raw.githubusercontent.com/TheBadRoger/ChuSQL/main/scripts/install.sh | sh -s -- --component web
```
2026-10-15 22:58:13 +08:00
也可从 ChuRepo 下载后执行：
```sh
curl -fsSL \
https://repo.chunana.cn/ChuNa7a/ChuSQL/raw/branch/main/scripts/install.sh \
-o install.sh
sh install.sh --component web
```
2026-10-03 02:17:46 +08:00
Windows PowerShell：
```powershell
irm https : // raw . githubusercontent . com / TheBadRoger / ChuSQL / main / scripts / install . ps1 -OutFile " $env:TEMP \install.ps1"
& " $env:TEMP \install.ps1" -Component web
```
2026-10-15 22:58:13 +08:00
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 不可用时，参见[包内安装 ](#包内安装 )或[从源码安装 ](#从源码安装 )。
2026-10-03 02:17:46 +08:00
## 安装方式
ChuSQL 支持三种安装方式：
| 方式 | 适用场景 |
| --- | --- |
| 在线安装 | 有网络，希望安装发行版本 |
| 包内安装 | 已下载发行包，或处于离线环境 |
| 源码安装 | 当前平台没有发行包，或需要自行修改源码 |
安装时可以选择 Web 管理端、命令行客户端，或同时安装两者。数据库服务及核心组件会按需安装。
安装过程中必须为管理员账号设置口令。口令不会以明文写入配置文件。
完成系统目录初始化后，安装程序默认会启动 `chusql-server` ；如不希望自动启动，可使用 `--no-start` （ `-NoStart` ）。
2026-10-13 14:09:36 +08:00
### Linux 用户服务
2026-10-05 22:22:23 +08:00
Linux 默认注册 `chusql-server.service` 为当前操作系统用户的 systemd 服务，并启用 linger 和开机启动，无需登录即可运行，异常退出后自动重启。需要可用的 systemd 用户会话；若启用 linger 时权限不足，按安装提示执行 `sudo loginctl enable-linger "$(id -un)"` 后重试。数据库管理员 `--user` 与运行服务的操作系统用户是两个独立身份。
2026-10-13 14:09:36 +08:00
`--no-start` 仅跳过本次启动，仍启用开机启动。非 systemd 环境可使用 `--no-service` 跳过服务注册，直接在后台启动进程。
2026-10-05 22:22:23 +08:00
```sh
systemctl --user status chusql-server.service
systemctl --user restart chusql-server.service
systemctl --user stop chusql-server.service
journalctl --user -u chusql-server.service
```
2026-10-03 02:17:46 +08:00
## 包内安装
2026-10-15 22:58:13 +08:00
发行包入口：[GitHub Releases ](https://github.com/TheBadRoger/ChuSQL/releases ) · [ChuRepo Releases ](https://repo.chunana.cn/ChuNa7a/ChuSQL/releases )。两站的发行包需分别发布；若所选站点没有对应版本或平台的包，请切换站点或从源码安装。
下载并解压对应平台的发行包后，在包根目录执行；包内安装不需要连接发行站点：
2026-10-03 02:17:46 +08:00
```sh
./install.sh --component web
```
Windows：
```powershell
.\ install . ps1 -Component web
```
## 常用安装选项
| Linux / macOS | Windows | 说明 |
| --- | --- | --- |
| `--component web\|cli\|both` | `-Component` | 选择安装组件 |
| `--install-dir DIR` | `-InstallDir` | 指定安装目录 |
| `--data-dir DIR` | `-DataDir` | 指定数据目录 |
| `--user NAME` | `-RootUser` | 指定管理员账号名 |
| `--no-start` | `-NoStart` | 安装后不自动启动服务 |
2026-10-05 22:22:23 +08:00
| `--no-service` | — | 跳过 Linux 服务注册和开机启动 |
2026-10-03 02:17:46 +08:00
| `--version TAG` | `-Version` | 指定发行版本 |
| `--list-versions` | `-ListVersions` | 列出可安装版本 |
| `--from-source` | — | 从源码构建并安装 |
自动化安装时建议通过环境变量提供管理员口令，避免口令出现在 shell 历史中。
## 从源码安装
源码安装需要 `git` 、`cargo` 、`stack` 和 `ghc` ；部分 Linux 环境还需要 zlib 开发包。
2026-10-15 22:58:13 +08:00
选择一个源码地址克隆（只需执行其中一条）：
2026-10-03 02:17:46 +08:00
```sh
2026-10-15 22:58:13 +08:00
# GitHub
git clone https://github.com/TheBadRoger/ChuSQL.git
# 或 ChuRepo
git clone https://repo.chunana.cn/ChuNa7a/ChuSQL.git
2026-10-03 02:17:46 +08:00
```
2026-10-15 22:58:13 +08:00
Linux 进入仓库后使用本地源码构建，避免再次连接 GitHub 克隆：
```sh
cd ChuSQL
sh scripts/install.sh --component web --from-source --source-dir .
```
`--from-source` 当前构建流程面向 Linux；
2026-10-03 02:17:46 +08:00
源码构建完成后的配置、初始化和启动流程与发行包安装一致。
## 安装完成后
默认安装包含以下主要内容：
- `chusql-server` ：数据库服务；
- `csql` ：命令行客户端；
- `chusql-web` ：
- `csql-bootstrap` ：系统目录初始化工具；
2026-10-05 00:15:01 +08:00
- `settings.toml` ：全局配置文件；
2026-10-03 02:17:46 +08:00
- 数据目录与日志目录。
常用命令：
```sh
chusql-server
csql
csql-web
```
管理员使用安装时设置的口令登录。
2026-10-11 17:32:12 +08:00
## 更新
重新运行安装脚本，指定相同的安装目录和组件即可更新，也可用 `--version TAG` 选择版本：
```sh
./install.sh --component both --install-dir " $HOME /.local/share/chusql" --version <tag>
```
Linux 更新会先停止该安装目录中的 Web 和数据库进程，保留已有 `settings.toml` 、数据库和管理员口令，再引导检查系统目录。修改数据位置须编辑配置并自行迁移数据；更新时不能用不同的 `--data-dir` 覆盖现有配置。安装默认重启数据库服务，Web 管理端需重新运行 `csql-web` 。
Linux 安装目录中保留 `uninstall.sh` 。卸载时指定安装目录，数据目录默认读取现有配置。
2026-10-03 02:17:46 +08:00
## 卸载
Linux / macOS：
```sh
./uninstall.sh --yes
```
Windows：
```powershell
.\ uninstall . ps1 -Yes
```
如需保留数据，可使用 `--keep-data` （ `-KeepData` ）；如需保留配置，可使用 `--keep-config` （ `-KeepConfig` ）。
2026-10-05 22:22:23 +08:00
Linux 卸载时会停止服务、取消开机启动并移除服务文件。用户的 linger 设置保留，其他用户服务仍可使用它。
2026-10-13 14:09:36 +08:00
## 发布校验
2026-10-05 22:22:23 +08:00
2026-10-13 14:09:36 +08:00
> [!IMPORTANT]
> SHA256 校验只检测产物损坏，不证明发布来源。发布签名、可信根和轮换验证尚未实现。
