> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pawsql.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> PawSQL 是一个产品：Cloud 是公网部署形态，Engine / Optimizer / Auditor / Advisor / Patroller 是同一产品的组件与交付形态，不是彼此独立的产品。 / PawSQL is a single product: Cloud is the public deployment form, while Engine / Optimizer / Auditor / Advisor / Patroller are components and delivery forms of the same product, not separate products.
> 术语以站内术语表为准：SQL 审核对应英文 SQL Review，查询重写对应 Query Rewrite，索引推荐对应 Index Recommendation；英文内容统一用 Review，不用 Audit。 / Use the site glossary for terminology: 审核 is SQL Review, 重写 is Query Rewrite, 索引推荐 is Index Recommendation; English content uses Review, never Audit.
> 引用能力范围或版本支持时以对应页面为准；标注 unknown、或 status 非 published 的内容表示尚未经产品核实，不应作为事实引用。 / Cite capability scope and version support from the corresponding page; content marked unknown, or with a status other than published, is not yet product-verified and must not be cited as fact.

# 部署 PawSQL Server

> 规划并完成 PawSQL Server 私有化部署、初始化和上线前验证。

PawSQL Server 用于在企业网络中提供私有化的 SQL 审核、优化和治理服务。本页说明稳定的部署流程和验收要求；具体安装命令、组件版本及参数以对应版本的正式交付包为准。

<Note>
  生产部署前应取得与目标版本一致的安装包、版本说明和部署参数。不要将其他版本的命令直接用于当前环境。
</Note>

## 目标

规划并完成 PawSQL Server 私有化部署、初始化和上线前验证。

## 部署前规划

| 项目    | 需要确认的内容               |
| ----- | --------------------- |
| 部署环境  | 开发、测试、预发布或生产          |
| 服务器资源 | CPU、内存、磁盘、操作系统和运行时    |
| 平台依赖  | 平台自身依赖的数据库、缓存或其他中间件   |
| 网络    | 服务域名、端口、代理、负载均衡和防火墙策略 |
| HTTPS | 证书来源、有效期、域名和更新方式      |
| 数据库访问 | PawSQL 到目标业务数据库的网络路径  |
| 身份认证  | 本地账号、企业统一身份认证或其他方式    |
| 持久化   | 配置、任务数据、日志和报告的存储位置    |
| 备份恢复  | 备份范围、频率、保留周期和恢复目标     |
| 运维责任  | 安装、升级、监控、安全和故障响应负责人   |

## 推荐环境划分

生产环境不应兼作版本测试环境。建议至少准备：

* **验证环境**：用于验证安装包、升级路径、规则行为和数据库兼容性。
* **生产环境**：承载正式用户、工作空间、审核工单和治理数据。

对高可用、容灾或大规模并发有要求时，应在部署前与 PawSQL 技术支持确认适用架构和容量方案。

## 部署流程

<Steps>
  <Step title="获取并核验交付物">
    确认安装包、版本号、校验信息、部署说明和 License 均对应本次交付。
  </Step>

  <Step title="准备基础环境">
    按版本要求准备服务器、平台依赖、存储目录、系统账号、域名和网络策略。
  </Step>

  <Step title="配置服务参数">
    配置平台依赖、访问地址、持久化目录、日志、认证和通知等参数。敏感值应使用安全的配置方式保存。
  </Step>

  <Step title="安装并启动服务">
    使用交付包提供的脚本或部署模板启动 PawSQL Server，记录实际使用的版本和配置变更。
  </Step>

  <Step title="完成系统初始化">
    根据初始化向导或交付说明创建管理员、导入 License，并设置组织级基础参数。
  </Step>

  <Step title="执行上线验证">
    验证登录、权限、任务处理、持久化、日志、通知和数据库连接等关键路径。
  </Step>
</Steps>

## 网络连通性

部署时通常需要验证以下方向的网络访问：

| 来源            | 目标            | 用途                 |
| ------------- | ------------- | ------------------ |
| 用户浏览器         | PawSQL Server | 访问 Web 控制台         |
| IDE、MCP 或集成系统 | PawSQL Server | 调用审核和优化能力          |
| PawSQL Server | 平台依赖          | 保存配置、任务和运行数据       |
| PawSQL Server | 业务数据库         | 获取元数据、执行计划或允许的验证信息 |
| PawSQL Server | 通知或身份服务       | 邮件、Webhook 或统一身份认证 |

具体端口取决于实际部署配置，不应在通用文档中假定固定值。

## 安全基线

* 使用独立的系统运行账号，不使用个人账号长期运行服务。
* 平台依赖和业务数据库账户遵循最小权限原则。
* 对外提供服务时启用 HTTPS，并建立证书更新机制。
* 密码和令牌不写入代码仓库、普通脚本或日志。
* 限制管理后台和高权限接口的网络访问范围。
* 设置日志与备份的访问权限和保留周期。
* 生产变更经过评审、备份、演练和回退准备。

## 上线验收

* [ ] 服务进程或容器运行正常。
* [ ] Web 控制台可通过预期域名访问。
* [ ] HTTPS 证书可信且域名匹配。
* [ ] 管理员可以登录，普通用户权限符合预期。
* [ ] License 状态正常。
* [ ] 可以创建工作空间和测试任务。
* [ ] 任务数据在服务重启后仍然存在。
* [ ] 日志、监控和通知可以正常使用。
* [ ] 已完成一次备份和恢复演练。
* [ ] 已记录当前版本、配置、负责人和回退方案。

<Warning>
  不要在未完成备份和回退准备的情况下直接升级生产环境。部署或升级后，应先使用脱敏 SQL 和非生产数据库完成验证。
</Warning>

## 常见问题

### 页面无法访问

依次检查服务状态、监听地址、域名解析、代理或负载均衡、防火墙和 HTTPS 证书。

### 可以登录但任务无法执行

检查分析服务状态、平台依赖连接、任务队列和 License。记录任务编号和完整错误信息。

### 无法连接业务数据库

从 PawSQL Server 所在网络验证数据库地址和端口，并检查白名单、TLS、账号权限及数据库连接数限制。

## 下一步

<CardGroup cols={2}>
  <Card title="验证安装与连接" href="/user-guide/installation/verify-installation" />

  <Card title="登录与身份认证" href="/user-guide/installation/authentication" />

  <Card title="工作空间和上下文" href="/user-guide/workspaces" />
</CardGroup>