|
| 1 | +# CBDB Online - Docker 开发环境 |
| 2 | + |
| 3 | +使用 Docker Compose 快速搭建 CBDB Online 开发环境,无需安装 PHP、Composer、MySQL 等依赖。 |
| 4 | + |
| 5 | +## 目录结构 |
| 6 | + |
| 7 | +``` |
| 8 | +/ |
| 9 | +├── docker/ |
| 10 | +│ ├── Dockerfile # PHP 7.4 + SQLite + Composer 镜像 |
| 11 | +│ ├── nginx.conf # Nginx 配置 |
| 12 | +│ └── php.ini # PHP 配置 |
| 13 | +├── docker-compose.yml # Docker Compose 配置文件 |
| 14 | +├── database/ |
| 15 | +│ └── database.sqlite3 # SQLite 数据库文件 |
| 16 | +├── .env # 环境配置文件 |
| 17 | +└── .env.docker.example # Docker 环境配置示例 |
| 18 | +``` |
| 19 | + |
| 20 | +默认的 SQLite 文件位于 `database/database.sqlite3`,Docker Compose 会将 PHP 应用运行在名为 `cbdb-php` 的容器中(对应 `php` 服务)。 |
| 21 | + |
| 22 | +## 技术特点 |
| 23 | + |
| 24 | +### SQLite 安装方式 |
| 25 | + |
| 26 | +本项目 Dockerfile 从 SQLite 官网下载并编译安装最新版本(3.45.0+),而不是使用 `apt install sqlite3`。 |
| 27 | + |
| 28 | +**原因**:Ubuntu 24.04 LTS 的 apt 仓库中的 SQLite3 版本存在已知问题,可能导致数据库兼容性或性能问题。从官网编译可以确保: |
| 29 | +- 使用最新稳定版本 |
| 30 | +- 避免发行版特定的补丁问题 |
| 31 | +- 获得最佳性能和最新特性 |
| 32 | + |
| 33 | +如需更新 SQLite 版本,修改 Dockerfile 中的环境变量: |
| 34 | +```dockerfile |
| 35 | +ENV SQLITE_VERSION=3450000 # 对应 3.45.0 |
| 36 | +ENV SQLITE_YEAR=2024 |
| 37 | +``` |
| 38 | + |
| 39 | +## 快速开始 |
| 40 | + |
| 41 | +### 1. 准备 SQLite 数据库 |
| 42 | + |
| 43 | +如果还没有 SQLite 数据库文件,可以: |
| 44 | + |
| 45 | +**方式一:创建空数据库并运行迁移** |
| 46 | +```bash |
| 47 | +touch database/database.sqlite3 |
| 48 | +``` |
| 49 | + |
| 50 | +**方式二:从 MySQL 导出(如果已有 MySQL 数据)** |
| 51 | +```bash |
| 52 | +php artisan db:export-to-sqlite --output=database/database.sqlite3 |
| 53 | +``` |
| 54 | +`db:export-to-sqlite` 默认为 `mysql` 连接,如需从其他连接导出可加上 `--source=connection_name`,也可以依需求附加 `--schema-only`、`--tables` 等参数。 |
| 55 | + |
| 56 | +### 2. 配置环境变量 |
| 57 | + |
| 58 | +复制 Docker 环境配置示例: |
| 59 | +```bash |
| 60 | +cp .env.docker.example .env |
| 61 | +``` |
| 62 | + |
| 63 | +编辑 `.env` 文件,确保数据库配置正确: |
| 64 | +```env |
| 65 | +DB_CONNECTION=sqlite |
| 66 | +DB_DATABASE=/var/www/html/database/database.sqlite3 |
| 67 | +``` |
| 68 | + |
| 69 | +**重要**:路径必须是容器内的路径 `/var/www/html/database/database.sqlite3`,不是本地路径。 |
| 70 | + |
| 71 | +### 3. 生成应用密钥(首次运行) |
| 72 | + |
| 73 | +```bash |
| 74 | +# 如果 .env 中 APP_KEY 为空,需要生成 |
| 75 | +docker compose run --rm php php artisan key:generate |
| 76 | +``` |
| 77 | + |
| 78 | +### 4. 启动服务 |
| 79 | + |
| 80 | +```bash |
| 81 | +docker compose up --build |
| 82 | +``` |
| 83 | + |
| 84 | +首次启动会构建镜像,大约需要 3-5 分钟。后续启动只需几秒钟。 |
| 85 | + |
| 86 | +### 5. 访问应用 |
| 87 | + |
| 88 | +打开浏览器访问: |
| 89 | +``` |
| 90 | +http://localhost:8000 |
| 91 | +``` |
| 92 | + |
| 93 | +## 常用命令 |
| 94 | + |
| 95 | +### 启动服务 |
| 96 | +```bash |
| 97 | +docker compose up # 前台运行,查看日志 |
| 98 | +docker compose up -d # 后台运行 |
| 99 | +``` |
| 100 | + |
| 101 | +### 停止服务 |
| 102 | +```bash |
| 103 | +docker compose down # 停止并删除容器 |
| 104 | +docker compose stop # 仅停止容器 |
| 105 | +``` |
| 106 | + |
| 107 | +### 重新构建 |
| 108 | +```bash |
| 109 | +docker compose up --build # 重新构建并启动 |
| 110 | +docker compose build --no-cache # 完全重新构建(不使用缓存) |
| 111 | +``` |
| 112 | + |
| 113 | +### 执行 Laravel 命令 |
| 114 | + |
| 115 | +```bash |
| 116 | +# 运行迁移 |
| 117 | +docker compose exec php php artisan migrate |
| 118 | + |
| 119 | +# 清除缓存 |
| 120 | +docker compose exec php php artisan cache:clear |
| 121 | +docker compose exec php php artisan config:clear |
| 122 | +docker compose exec php php artisan route:clear |
| 123 | +docker compose exec php php artisan view:clear |
| 124 | + |
| 125 | +# 生成应用密钥 |
| 126 | +docker compose exec php php artisan key:generate |
| 127 | + |
| 128 | +# 进入 PHP 容器 |
| 129 | +docker compose exec php bash |
| 130 | + |
| 131 | +# 运行 Composer |
| 132 | +docker compose exec php composer install |
| 133 | +docker compose exec php composer update |
| 134 | +docker compose exec php composer dump-autoload |
| 135 | +``` |
| 136 | + |
| 137 | +### 查看日志 |
| 138 | +```bash |
| 139 | +docker compose logs # 查看所有服务日志 |
| 140 | +docker compose logs php # 查看 PHP 服务日志 |
| 141 | +docker compose logs web # 查看 Nginx 服务日志 |
| 142 | +docker compose logs -f # 实时查看日志 |
| 143 | +``` |
| 144 | + |
| 145 | +## 开发工作流 |
| 146 | + |
| 147 | +### 1. 修改代码 |
| 148 | +直接在本地编辑器修改代码,容器会自动映射最新的代码: |
| 149 | +```bash |
| 150 | +# 代码映射: . -> /var/www/html |
| 151 | +``` |
| 152 | + |
| 153 | +刷新浏览器即可看到变化(无需重启容器)。 |
| 154 | + |
| 155 | +### 2. 拉取最新代码 |
| 156 | +```bash |
| 157 | +git pull |
| 158 | +# 浏览器刷新即可看到变化 |
| 159 | +``` |
| 160 | + |
| 161 | +### 3. 更新依赖 |
| 162 | +```bash |
| 163 | +# 如果 composer.json 有变化 |
| 164 | +docker compose exec php composer install |
| 165 | + |
| 166 | +# 如果需要重新构建镜像 |
| 167 | +docker compose up --build |
| 168 | +``` |
| 169 | + |
| 170 | +### 4. 运行数据库迁移 |
| 171 | +```bash |
| 172 | +docker compose exec php php artisan migrate |
| 173 | +``` |
| 174 | + |
| 175 | +## 文件权限问题 |
| 176 | + |
| 177 | +如果遇到 `storage/` 或 `bootstrap/cache/` 权限错误: |
| 178 | + |
| 179 | +```bash |
| 180 | +docker compose exec php chown -R www-data:www-data storage bootstrap/cache |
| 181 | +docker compose exec php chmod -R 775 storage bootstrap/cache |
| 182 | +``` |
| 183 | + |
| 184 | +## 数据库管理 |
| 185 | + |
| 186 | +### 查看 SQLite 数据 |
| 187 | + |
| 188 | +**方式一:使用 SQLite 客户端** |
| 189 | +```bash |
| 190 | +# 安装 sqlite3(如果未安装) |
| 191 | +# macOS |
| 192 | +brew install sqlite |
| 193 | + |
| 194 | +# Linux |
| 195 | +sudo apt-get install sqlite3 |
| 196 | + |
| 197 | +# 打开数据库 |
| 198 | +sqlite3 database/database.sqlite3 |
| 199 | + |
| 200 | +# SQLite 命令 |
| 201 | +.tables # 查看所有表 |
| 202 | +.schema table_name # 查看表结构 |
| 203 | +SELECT * FROM users; # 执行查询 |
| 204 | +.quit # 退出 |
| 205 | +``` |
| 206 | + |
| 207 | +**方式二:在容器内查看** |
| 208 | +```bash |
| 209 | +docker compose exec php sqlite3 /var/www/html/database/database.sqlite3 |
| 210 | +``` |
| 211 | + |
| 212 | +### 备份数据库 |
| 213 | +```bash |
| 214 | +cp database/database.sqlite3 database/database.sqlite3.backup |
| 215 | +``` |
| 216 | + |
| 217 | +### 从 MySQL 重新导出 |
| 218 | +```bash |
| 219 | +# 确保 .env 配置为 MySQL |
| 220 | +php artisan db:export-to-sqlite --output=database/database.sqlite3 |
| 221 | + |
| 222 | +# 然后切换回 SQLite 配置并重启容器 |
| 223 | +docker compose restart |
| 224 | +``` |
| 225 | + |
| 226 | +## 升级 PHP 版本 |
| 227 | + |
| 228 | +要升级到更高版本的 PHP(如 PHP 8.1),只需修改 `docker/Dockerfile` 第一行: |
| 229 | + |
| 230 | +```dockerfile |
| 231 | +# 从 |
| 232 | +FROM php:7.4-fpm |
| 233 | + |
| 234 | +# 改为 |
| 235 | +FROM php:8.1-fpm |
| 236 | +``` |
| 237 | + |
| 238 | +然后重新构建: |
| 239 | +```bash |
| 240 | +docker compose down |
| 241 | +docker compose up --build |
| 242 | +``` |
| 243 | + |
| 244 | +## 故障排查 |
| 245 | + |
| 246 | +### 容器启动失败 |
| 247 | +```bash |
| 248 | +# 查看详细日志 |
| 249 | +docker compose logs |
| 250 | + |
| 251 | +# 检查端口占用 |
| 252 | +lsof -i :8000 # macOS/Linux |
| 253 | +netstat -ano | findstr :8000 # Windows |
| 254 | + |
| 255 | +# 删除所有容器重新开始 |
| 256 | +docker compose down |
| 257 | +docker compose up --build |
| 258 | +``` |
| 259 | + |
| 260 | +### 页面显示 500 错误 |
| 261 | +```bash |
| 262 | +# 检查 Laravel 日志 |
| 263 | +docker compose exec php tail -f storage/logs/laravel.log |
| 264 | + |
| 265 | +# 检查权限 |
| 266 | +docker compose exec php ls -la storage/ |
| 267 | +docker compose exec php chown -R www-data:www-data storage bootstrap/cache |
| 268 | +``` |
| 269 | + |
| 270 | +### Composer 依赖安装失败 |
| 271 | +```bash |
| 272 | +# 进入容器手动安装 |
| 273 | +docker compose exec php bash |
| 274 | +composer install --verbose |
| 275 | +``` |
| 276 | + |
| 277 | +### 数据库连接失败 |
| 278 | +检查 `.env` 文件: |
| 279 | +- `DB_CONNECTION=sqlite` |
| 280 | +- `DB_DATABASE=/var/www/html/database/database.sqlite3` (容器内路径,不是本地路径) |
| 281 | +- 确保 `database/database.sqlite3` 文件存在且有读写权限 |
| 282 | + |
| 283 | +## 生产部署注意事项 |
| 284 | + |
| 285 | +此 Docker 配置仅用于**开发环境**,生产环境需要: |
| 286 | + |
| 287 | +1. 使用生产优化的 Dockerfile(多阶段构建、最小化镜像) |
| 288 | +2. 配置 HTTPS |
| 289 | +3. 使用生产级数据库(MySQL、PostgreSQL) |
| 290 | +4. 配置日志收集 |
| 291 | +5. 设置健康检查 |
| 292 | +6. 使用环境变量管理敏感信息 |
| 293 | +7. 禁用调试模式(`APP_DEBUG=false`) |
| 294 | + |
| 295 | +## 其他资源 |
| 296 | + |
| 297 | +- [Laravel 官方文档](https://laravel.com/docs) |
| 298 | +- [Docker Compose 文档](https://docs.docker.com/compose/) |
| 299 | +- [PHP Docker 官方镜像](https://hub.docker.com/_/php) |
| 300 | + |
| 301 | +## 技术支持 |
| 302 | + |
| 303 | +遇到问题请: |
| 304 | +1. 查看项目 Issues |
| 305 | +2. 查看 Laravel 日志:`storage/logs/laravel.log` |
| 306 | +3. 查看 Docker 日志:`docker compose logs` |
0 commit comments