diff --git a/docs/docker-compose安装指南.md b/docs/docker-compose安装指南.md index 38f9745..ac25f8b 100644 --- a/docs/docker-compose安装指南.md +++ b/docs/docker-compose安装指南.md @@ -1,66 +1,77 @@ -## Docker Compose 快速部署指南 - -本指南介绍如何使用 Docker Compose 快速部署 Xboard。默认使用 SQLite 数据库,无需额外安装 MySQL。 - -### 1. 环境准备 - -安装 Docker: -```bash +## Docker-Compose 部署教程 +本文教你如何在命令行使用docker-compose + sqlite来快速部署Xboard +如果你需要使用Mysql,你需要自行处理好Mysql的安装。 +### 部署 (使用docker-compose 2分钟部署) +> 在此提供Xboard安装、快速体验Xboard的步骤。 +使用docker compose + sqlite 快速部署站点(**无需安装Mysql以及redis**) +1. 安装docker +``` curl -sSL https://get.docker.com | bash - -# CentOS 系统需要执行: +``` +Centos系统可能需要执行下面命令来启动Docker。 +``` systemctl enable docker systemctl start docker ``` - -### 2. 部署步骤 - -1. 获取项目文件: -```bash -git clone -b docker-compose --depth 1 https://github.com/cedar2025/Xboard +2. 获取Docker compose 文件 +``` +git clone -b docker-compose --depth 1 https://github.com/cedar2025/Xboard cd Xboard ``` - -2. 安装数据库: -```bash -# 快速安装(推荐新手使用) -docker compose run -it --rm \ - -e enable_sqlite=true \ - -e enable_redis=true \ - -e admin_account=admin@demo.com \ - web php artisan xboard:install - -# 自定义配置安装(高级用户) -docker compose run -it --rm web php artisan xboard:install +3. 执行数据库安装命令 +> 选择 **启用sqlite** 和 **Docker内置的Redis** ``` -> 安装完成后请保存返回的后台地址和管理员账号密码 +docker compose run -it --rm -e enable_sqlite=true -e enable_redis=true -e admin_account=your_admin_email@example.com xboard php artisan xboard:install +``` +> 或者根据自己的需要在运行时选择 +``` +docker compose run -it --rm xboard php artisan xboard:install +``` +> 执行这条命令之后,会返回你的后台地址和管理员账号密码(你需要记录下来) +> 你需要执行下面的 **启动xborad** 步骤之后才能访问后台 -3. 启动服务: -```bash +4. 启动Xboard +``` docker compose up -d ``` +> 安装完成之后即可访问你的站点 +5. 访问站点 +> 启动之后网站端口默认为7001, 你可以配置nginx反向代理使用80端口 -4. 访问站点: -- 默认端口:7001 -- 网站地址:http://服务器IP:7001 +网站地址: http://你的IP:7001/ +在此你已经成功部署了, 你可以访问网址体验Xboard的完整功能, -### 3. 版本更新 +> 如果你需要使用mysql,请自行安装Mysql后重新部署 -```bash +### **更新** +1. 修改版本 +``` cd Xboard +vi docker-compose.yaml +``` +> 修改docker-compose.yaml 当中image后面的版本号为你需要的版本 +> 如果为版本为latest 则可以忽略这一步,直接进行第二步 + +2. 更新数据库(可以执行多次都是安全的) +``` docker compose pull docker compose down -docker compose run -it --rm web php artisan xboard:update +docker compose run -it --rm xboard php artisan xboard:update +docker compose up -d +``` +> 即可更新成功 + +### **回滚** +> 此回滚不回滚数据库,是否回滚数据库请查看相关文档 +1. 回退版本 +``` +vi docker-compose.yaml +``` +> 修改docker-compose.yaml 当中image后面的版本号为更新前的版本号 +2. 启动 +``` docker compose up -d ``` -### 4. 版本回滚 - -1. 修改 `docker-compose.yaml` 中的版本号为需要回滚的版本 -2. 执行:`docker compose up -d` - -### 注意事项 - -- 如需使用 MySQL,请自行安装并重新部署 -- 代码修改后需要重启服务才能生效 -- 可以配置 Nginx 反向代理使用 80 端口 +### 注意 +启用webman后做的任何代码修改都需要重启生效