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