【help】docs(install): 优化安装说明文档结构及内容,新增Docker快速部署指南

This commit is contained in:
sugar1569 2026-03-13 15:35:07 +08:00
parent 66dafae70f
commit 560da2460b

View File

@ -1,27 +1,48 @@
## 安装
> 运行环境要求 PHP 7.1~7.4,数据库版本为 Mysql 5.7。
## 一键安装
创建站点,运行目录选择项目根目录下的/public,设置伪静态为thinkphp的伪静态
在浏览器中输入你的域名或IP(例如:www.yourdomain.com),
安装程序会自动执行安装。期间系统会提醒你输入数据库信息以完成安装,安装完成后建议删除install目录下index.php文件或将其改名。
# CRMEB 安装说明
后台访问地址: 域名/admin
> 运行环境要求:PHP 7.1~7.4,数据库版本为 MySQL 5.7~8.0
公众号和H5首页访问地址: 域名/
---
提示:访问不了请检测 [URL重写](https://doc.crmeb.com/web/single/crmeb_v4/1139) 是否配置好
安装过程中请牢记您的账号密码!
## 一、一键安装
1. 创建站点,运行目录选择项目根目录下的 `/public`
2. 设置伪静态为 ThinkPHP 的伪静态
3. 在浏览器中输入你的域名或IP(例如:www.yourdomain.com)
4. 安装程序会自动执行安装,期间系统会提醒你输入数据库信息以完成安装
5. 安装完成后建议删除 `install` 目录下 `index.php` 文件或将其改名
### 访问地址
| 端口 | 地址 |
|------|------|
| 后台管理 | 域名/admin |
| 公众号和H5首页 | 域名/ |
> 提示:访问不了请检测 [URL重写](https://doc.crmeb.com/web/single/crmeb_v4/1139) 是否配置好
>
> 安装过程中请牢记您的账号密码!
---
## 二、重新安装
## 重新安装
1. 清除数据库
2. 删除 /public/install.lock 文件
2. 删除 `/public/install.lock` 文件
## 手动安装
1.创建数据库,导入数据库文件
数据库文件目录/public/install/crmeb.sql
2.修改数据库连接文件
配置文件路径/.env
~~~
---
## 三、手动安装
### 1. 创建数据库
导入数据库文件:`/public/install/crmeb.sql`
### 2. 修改数据库连接文件
配置文件路径:`/.env`
```ini
APP_DEBUG = true
[APP]
@ -49,85 +70,143 @@ SELECT = 0
[QUEUE]
QUEUE_NAME = crmeb
~~~
3.修改目录权限(linux系统)777
/public
/runtime
4.后台登录:
http://域名/admin
默认账号:admin 密码:crmeb.com
## 消息队列
linux系统安装Supervisor管理器,添加守护进程
用户选择 www
运行目录选择项目根目录
启动命令:php think queue:listen --queue
## 定时任务
在自动收货,库存预警等功能使用到
```sh
php think timer [ status ] [ --d ]
```
参数
- status: 状态
- start: 启动
- stop: 关闭
- restart: 重启
- --d : 后台执行
## 长连接服务
在h5聊天,后台管理员消息通知等功能使用到
先修改网站nginx配置
~~~
### 3. 修改目录权限(Linux系统)
以下目录需要设置 777 权限:
```bash
chmod -R 777 public runtime
```
### 4. 后台登录
- 地址:http://域名/admin
- 默认账号:`admin`
- 默认密码:`crmeb.com`
---
## 四、消息队列
Linux 系统安装 Supervisor 管理器,添加守护进程:
- 用户:`www`
- 运行目录:项目根目录
- 启动命令:
```bash
php think queue:listen --queue
```
---
## 五、定时任务
在自动收货、库存预警等功能使用到:
```bash
php think timer [status] [--d]
```
| 参数 | 说明 |
|------|------|
| status | 状态:start(启动)、stop(关闭)、restart(重启) |
| --d | 后台执行 |
---
## 六、长连接服务
在 H5 聊天、后台管理员消息通知等功能使用到。
### 1. 修改 Nginx 配置
```nginx
# 后台管理员消息通知 (对应 admin 服务,端口 40001)
location /notice {
proxy_pass http://127.0.0.1:20002/;
proxy_pass http://127.0.0.1:40001/;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header X-real-ip $remote_addr;
proxy_set_header X-Forwarded-For $remote_addr;
}
location /msg {
proxy_pass http://127.0.0.1:20003/;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header X-real-ip $remote_addr;
proxy_set_header X-Forwarded-For $remote_addr;
}
~~~
对应的端口要和 /config/workerman.php 里面保持一致
linux系统直接运行
```sh
php think workerman [ status ] [ server ] [ --d ]
# H5端聊天服务 (对应 chat 服务,端口 40002)
location /msg {
proxy_pass http://127.0.0.1:40002/;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header X-real-ip $remote_addr;
proxy_set_header X-Forwarded-For $remote_addr;
}
```
windows环境下需要分三步执行
```sh
> 对应的端口要和 `/config/workerman.php` 里面保持一致
### 2. 启动服务
**Linux 系统:**
```bash
php think workerman [status] [server] [--d]
```
**Windows 环境:**
需要分三步执行:
```bash
# 内部通讯服务
php think workerman start channel
# h5端聊天服务
# H5端聊天服务
php think workerman start chat
# 后台管理员通知
php think workerman start admin
```
或者直接双击运行 /workerman.bat
参数
- status: 状态
- start: 启动
- stop: 关闭
- restart: 重启
- server: 服务 (windows)
- channel: 内部通讯
- chat: h5
- admin: 后台
或者直接双击运行 `/workerman.bat`
- --d : 后台执行
### 3. 参数说明
| 参数 | 说明 |
|------|------|
| status | 状态:start(启动)、stop(关闭)、restart(重启) |
| server | 服务(Windows):channel(内部通讯)、chat(H5)、admin(后台) |
| --d | 后台执行 |
---
## 七、Docker 快速部署
```bash
# 拉取并运行 CRMEB Docker 镜像
docker run -d --name crmeb -p 8080:80 ccr.ccs.tencentyun.com/crmebky_php/crmebky:latest
```
### 访问服务
| 服务 | 地址 | 账号/密码 |
|------|------|----------|
| 网站 | http://localhost:8080 | - |
| 后台 | http://localhost:8080/admin | admin / crmeb.com |
| MySQL | localhost:3306 | root / 123456 |
| Redis | localhost:6379 | - |
> 详细说明点击查看 [Docker 部署文档](/help/docker/README.md)
---
## 相关链接
- [快速一键安装部署](https://doc.crmeb.com/single_open/open_v54/20366)
- [手动配置安装](https://doc.crmeb.com/single_open/open_v54/20389)
- [Docker-Compose 一键部署](https://doc.crmeb.com/single_open/open_v54/20145)
- [宝塔环境一键安装](https://doc.crmeb.com/single_open/open_v54/19892)
- [使用文档](https://doc.crmeb.com/single_open/open_v54/19849)
- [接口文档](https://doc.crmeb.com/single_open/open_v54/21040)