diff --git a/docs/config/welcome.ts b/docs/config/welcome.ts index adf2358090..00964ab2d3 100644 --- a/docs/config/welcome.ts +++ b/docs/config/welcome.ts @@ -31,6 +31,7 @@ export default [ children: [ '/welcome/getting-started/installation', '/welcome/getting-started/installation/docker-compose', + '/welcome/getting-started/installation/1panel', '/welcome/getting-started/installation/create-nocobase-app', '/welcome/getting-started/installation/git-clone', // '/welcome/getting-started/installation/install-plugin', @@ -48,6 +49,7 @@ export default [ children: [ '/welcome/getting-started/upgrading', '/welcome/getting-started/upgrading/docker-compose', + '/welcome/getting-started/upgrading/1panel', '/welcome/getting-started/upgrading/create-nocobase-app', '/welcome/getting-started/upgrading/git-clone', ], diff --git a/docs/zh-CN/welcome/getting-started/installation/1panel.md b/docs/zh-CN/welcome/getting-started/installation/1panel.md new file mode 100644 index 0000000000..4889b76027 --- /dev/null +++ b/docs/zh-CN/welcome/getting-started/installation/1panel.md @@ -0,0 +1,50 @@ +# 1Panel 面板安装 + +## 0. 先决条件 + +⚡⚡ 请确保你已经安装了 [1Panel](https://1panel.cn/docs/) 面板 + +## 1. 搜索应用 + +1. 登录 1Panel 管理面板 +2. 点击左侧菜单栏中的 **「应用商店」** +3. 在 **「开发工具」** 分类下找到 NocoBase 应用 + +## 2. 安装配置 + +点击 **「安装」** 按钮,进入安装配置页面,填写以下信息: + +- **名称**:要创建的 NocoBase 应用的名称 +- **版本**:选择 NocoBase 版本(推荐使用最新稳定版) +- **端口**:设置服务访问端口 +- **数据库服务器**:选择已安装的数据库类型 + - 支持:MySQL / PostgreSQL / MariaDB + - *如未安装数据库,请先在应用商店中安装* +- **数据库名**:NocoBase 使用的数据库名称 +- **数据库用户名**:数据库连接用户名 +- **数据库用户密码**:数据库连接密码 +- **应用密钥**:用于加密和解密数据的密钥(可以使用默认值) +- **时区**:输入服务器所在时区(默认 Asia/Shanghai) +- **高级设置**:务必勾选端口外部访问 + +点击 **「确认」** 按钮开始安装,系统将自动: + +- 下载 NocoBase Docker 镜像 +- 创建并配置数据库 +- 启动应用服务 + +## 3. 登录 NocoBase + +1. 进入 **「已安装」** 应用列表 +2. 找到 NocoBase 应用 +3. 点击 **「跳转」** 按钮即可打开 NocoBase + +提示:建议先在 **「面板设置」** 中配置 **「默认访问地址」**,以便直接跳转。 + +## 4. 管理 NocoBase + +在 **「已安装」** 页面中,你可以对 NocoBase 应用执行以下操作: + +- **服务控制**:启动 / 停止 / 重启 +- **运维操作**:查看日志 / 备份与恢复 / 进入终端 +- **应用管理**:重建应用 / 卸载应用 / 编辑应用 diff --git a/docs/zh-CN/welcome/getting-started/installation/index.md b/docs/zh-CN/welcome/getting-started/installation/index.md index e81e0521b8..2e50c8edb3 100644 --- a/docs/zh-CN/welcome/getting-started/installation/index.md +++ b/docs/zh-CN/welcome/getting-started/installation/index.md @@ -2,9 +2,10 @@ ## 安装方式 -NocoBase 支持三种安装方式: +NocoBase 支持四种安装方式: - [Docker 安装(推荐)](./docker-compose.md) +- [1Panel 面板安装](./1panel.md) - [create-nocobase-app 安装](./create-nocobase-app.md) - [Git 源码安装](./git-clone.md) @@ -14,6 +15,12 @@ NocoBase 支持三种安装方式: 适合无代码场景,不需要写代码。升级时,下载最新镜像并重启即可。 +### 1Panel 面板安装 + +通过 1Panel Linux 面板一键部署,无需命令行操作。 + +支持可视化管理、在线升级、备份与恢复,适合希望快速上手和持续运维的用户。 + ### create-nocobase-app 安装 项目的业务代码完全独立,支持低代码开发。 diff --git a/docs/zh-CN/welcome/getting-started/upgrading/1panel.md b/docs/zh-CN/welcome/getting-started/upgrading/1panel.md new file mode 100644 index 0000000000..c8f11af919 --- /dev/null +++ b/docs/zh-CN/welcome/getting-started/upgrading/1panel.md @@ -0,0 +1,58 @@ +# 1Panel 面板安装的升级 + +## 1. 进入可升级页面 + +1. 登录 1Panel 管理面板 +2. 点击左侧菜单 **「应用商店」** +3. 选择 **「可升级」** 标签页 +4. 在应用列表中找到 NocoBase 应用 + +## 2. 执行升级操作 + +点击 NocoBase 应用右侧的 **「升级」** 按钮,在升级对话框中进行以下配置: + +- **目标版本**:选择要升级到的 NocoBase 版本 +- **升级前备份应用**: + - ✅ 推荐启用此选项 + - 升级失败时系统会自动使用备份回滚 + - 回滚日志可在 **「日志审计」→「系统日志」** 中查看 +- **自动拉取镜像**: + - ✅ 默认启用 + - 在应用启动前自动执行 `docker pull` 拉取最新镜像 + - 确保获取到最新的应用文件 + +## 3. 文件变更确认 + +点击 **「查看对比」** 按钮,检查配置变更: + +- 升级操作会替换 `docker-compose.yml` 文件 +- 对比新旧配置文件的差异 +- 如有手动修改的配置,请决定是否保留更改 + +## 4. 开始升级 + +确认所有配置无误后,点击 **「确认」** 按钮,系统将开始自动升级流程: + +- 执行应用备份(如启用) +- 拉取新的 Docker 镜像 +- 停止旧版本容器 +- 启动新版本容器 +- 验证服务状态 + +升级后验证,确认服务状态: + +- 进入 **「已安装」** 页面,确认 NocoBase 容器状态为「运行中」 +- 查看应用日志,确认无错误信息 +- 访问 NocoBase 应用,验证功能正常 + +## 5. 故障处理 + +如在升级过程中出现异常,系统会 **自动回滚** 到升级前的状态: + +- 若启用了 **备份功能**,系统将在升级失败后自动恢复至升级前状态 +- 可前往 **「日志审计」** → **「系统日志」** 查看具体的失败原因 + +你也可以 **手动恢复**: + +- 进入 **「备份」** 页面 +- 选择最近的备份文件执行恢复操作 diff --git a/docs/zh-CN/welcome/getting-started/upgrading/index.md b/docs/zh-CN/welcome/getting-started/upgrading/index.md index b914a5ebc7..b55c1b7202 100644 --- a/docs/zh-CN/welcome/getting-started/upgrading/index.md +++ b/docs/zh-CN/welcome/getting-started/upgrading/index.md @@ -3,5 +3,6 @@ NocoBase 支持三种安装方式,升级时略有不同。 - [Docker 安装的升级](./docker-compose.md) +- [1Panel 面板安装的升级](./1panel.md) - [create-nocobase-app 安装的升级](./create-nocobase-app.md) - [Git 源码安装的升级](./git-clone.md)