jhumanj/opnform-api

OpnForm 后端 Laravel 镜像文档

镜像概述

本镜像为OpnForm应用的后端Docker镜像，基于Laravel框架构建，主要用于提供OpnForm的API服务。OpnForm是一款开源表单构建工具，该镜像作为其核心后端组件，负责处理表单创建、提交、数据存储与管理等核心业务逻辑，支持与前端应用分离部署。

核心功能与特性

核心功能

• 基于Laravel框架提供RESTful API服务，支持表单CRUD、提交数据处理、用户认证等核心业务逻辑
• 集成数据库交互层，支持MySQL、PostgreSQL等关系型数据库
• 提供队列任务处理能力，支持表单提交通知、数据导出等异步任务
• 内置缓存机制，优化API响应性能

特性

• 容器化设计，支持跨环境一致部署
• 环境变量驱动配置，支持灵活定制部署参数
• 兼容Docker Compose等编排工具，便于服务集成
• 基于官方PHP镜像构建，包含必要扩展（如pdo_mysql、redis等）

使用场景

• OpnForm应用生产环境后端服务部署
• 开发/测试环境中独立运行后端API服务
• 需要分离部署前后端的OpnForm定制化部署场景
• 与第三方服务集成时作为独立API服务节点

使用方法

前置要求

• Docker Engine 20.10+ 或 Docker Desktop
• 可用的数据库服务（MySQL 8.0+/PostgreSQL 13+）
• （可选）Redis服务（用于缓存和队列）

Docker Run 部署示例

bash
docker run -d \
  --name opnform-backend \
  -p 8000:8000 \
  -e APP_ENV=production \
  -e APP_KEY=base64:your_laravel_app_key \
  -e DB_CONNECTION=mysql \
  -e DB_HOST=mysql-host \
  -e DB_PORT=3306 \
  -e DB_DATABASE=opnform \
  -e DB_USERNAME=opnform_user \
  -e DB_PASSWORD=your_db_password \
  -e REDIS_HOST=redis-host \
  -e QUEUE_CONNECTION=redis \
  opnform/backend:latest

Docker Compose 配置示例

yaml
version: '3.8'

services:
  backend:
    image: opnform/backend:latest
    container_name: opnform-backend
    restart: always
    ports:
      - "8000:8000"
    environment:
      - APP_ENV=production
      - APP_KEY=base64:your_laravel_app_key  # 必须生成并替换
      - DB_CONNECTION=mysql
      - DB_HOST=db
      - DB_PORT=3306
      - DB_DATABASE=opnform
      - DB_USERNAME=root
      - DB_PASSWORD=root_password
      - REDIS_HOST=redis
      - QUEUE_CONNECTION=redis
      - CACHE_DRIVER=redis
    depends_on:
      - db
      - redis

  db:
    image: mysql:8.0
    container_name: opnform-mysql
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=root_password
      - MYSQL_DATABASE=opnform
    volumes:
      - mysql-data:/var/lib/mysql

  redis:
    image: redis:alpine
    container_name: opnform-redis
    restart: always
    volumes:
      - redis-data:/data

volumes:
  mysql-data:
  redis-data:

关键环境变量配置

初始化数据库

首次启动需执行数据库迁移：

bash
docker exec -it opnform-backend php artisan migrate --force

启动队列 worker（生产环境）

bash
docker exec -it opnform-backend php artisan queue:work --daemon

注意事项

• APP_KEY必须通过php artisan key:generate生成（可临时启动容器执行该命令）
• 生产环境建议使用外部数据库服务，避免容器内数据丢失
• 建议通过反向代理（如Nginx）暴露服务，并启用HTTPS
• 定期备份数据库数据，避免数据丢失