govpf/mes-demarches

Mes-Démarches.gov.pf Docker镜像文档

镜像概述和主要用途

Mes-Démarches.gov.pf是一个基于法国***"démarches-simplifiees.fr"项目的热带化版本，旨在满足法属波利尼西亚对行政手续100%数字化的迫切需求。该镜像是一个完整的Web应用解决方案，提供行政手续在线处理功能，帮助机构实现数字化转型。

核心功能和特性

• 行政手续全流程数字化处理
• 用户友好的界面设计，支持多设备访问
• 文档上传、处理和电子签名功能
• 工作流管理和任务跟踪系统
• 实时通知和提醒功能
• 数据安全和隐私保护机制
• 多语言支持，适应法属波利尼西亚多元文化环境
• 可扩展的架构设计，支持未来功能扩展

使用场景和适用范围

• ***机构内部行政流程数字化
• 公民和企业在线提交行政申请
• ***部门之间的数据共享和协作
• 行政手续状态跟踪和查询
• 报表生成和数据分析
• 适用于法属波利尼西亚各级机构、公共服务部门以及需要与进行行政交互的公民和企业。

详细的使用方法和配置说明

环境要求

• Docker Engine 20.10.0+
• Docker Compose 2.0+
• 至少4GB RAM
• 20GB可用磁盘空间
• 网络连接（用于下载依赖和更新）

技术依赖

核心服务

• PostgreSQL：数据库服务
• Redis：缓存和消息队列
• ImageMagick：图像处理和水印生成
• Chrome/Chromium：用于PDF生成和测试

应用栈

• Ruby on Rails：Web应用框架
• Sidekiq：异步任务处理
• Lightgallery：图片画廊展示（开源许可）
• ViteJS：前端构建工具

Docker部署方案

docker-compose配置示例

yaml
version: '3.8'

services:
  web:
    image: mes-demarches.gov.pf:latest
    restart: always
    ports:
      - "3000:3000"
    environment:
      - RAILS_ENV=production
      - DATABASE_URL=postgres://md:md@db:5432/mes_demarches
      - REDIS_URL=redis://redis:6379/0
      - SECRET_KEY_BASE=your_secret_key_base
      - SMTP_HOST=smtp.example.com
      - SMTP_PORT=587
      - SMTP_USERNAME=your_smtp_username
      - SMTP_PASSWORD=your_smtp_password
    depends_on:
      - db
      - redis
      - sidekiq
    volumes:
      - app_data:/app/public
      - app_logs:/app/log

  db:
    image: postgres:14
    restart: always
    environment:
      - POSTGRES_USER=md
      - POSTGRES_PASSWORD=md
      - POSTGRES_DB=mes_demarches
    volumes:
      - postgres_data:/var/lib/postgresql/data

  redis:
    image: redis:alpine
    restart: always
    volumes:
      - redis_data:/data

  sidekiq:
    image: mes-demarches.gov.pf:latest
    restart: always
    command: bundle exec sidekiq
    environment:
      - RAILS_ENV=production
      - DATABASE_URL=postgres://md:md@db:5432/mes_demarches
      - REDIS_URL=redis://redis:6379/0
      - SECRET_KEY_BASE=your_secret_key_base
    depends_on:
      - db
      - redis

volumes:
  postgres_data:
  redis_data:
  app_data:
  app_logs:

docker run命令示例

bash
# 启动数据库
docker run -d \
  --name mes-demarches-db \
  -e POSTGRES_USER=md \
  -e POSTGRES_PASSWORD=md \
  -e POSTGRES_DB=mes_demarches \
  -v postgres_data:/var/lib/postgresql/data \
  postgres:14

# 启动Redis
docker run -d \
  --name mes-demarches-redis \
  -v redis_data:/data \
  redis:alpine

# 启动应用
docker run -d \
  --name mes-demarches-app \
  -p 3000:3000 \
  -e RAILS_ENV=production \
  -e DATABASE_URL=postgres://md:md@mes-demarches-db:5432/mes_demarches \
  -e REDIS_URL=redis://mes-demarches-redis:6379/0 \
  -e SECRET_KEY_BASE=your_secret_key_base \
  --link mes-demarches-db:db \
  --link mes-demarches-redis:redis \
  mes-demarches.gov.pf:latest

# 启动Sidekiq worker
docker run -d \
  --name mes-demarches-sidekiq \
  -e RAILS_ENV=production \
  -e DATABASE_URL=postgres://md:md@mes-demarches-db:5432/mes_demarches \
  -e REDIS_URL=redis://mes-demarches-redis:6379/0 \
  -e SECRET_KEY_BASE=your_secret_key_base \
  --link mes-demarches-db:db \
  --link mes-demarches-redis:redis \
  mes-demarches.gov.pf:latest \
  bundle exec sidekiq

环境变量配置说明

ImageMagick安全配置

为防止***图像利用，需配置ImageMagick安全策略。在生产环境中，建议添加以下策略：

xml
<policymap>
    <policy domain="coder" rights="none" pattern="*"/>
    <policy domain="coder" rights="read | write" pattern="{JPG,JPEG,PNG,JSON}"/>
    <policy domain="module" rights="none" pattern="{MSL,MVG,PS,SVG,URL,XPS}"/>
</policymap>

数据库初始化

首次使用需要创建数据库用户和初始化数据库：

bash
# 进入数据库容器
docker exec -it mes-demarches-db psql -U postgres

# 在PostgreSQL终端执行
CREATE USER md WITH PASSWORD 'md' SUPERUSER;
CREATE USER md_test WITH PASSWORD 'md_test' SUPERUSER;
\q

# 初始化数据库结构和种子数据
docker exec -it mes-demarches-app bin/setup

常用操作

启动应用服务

bash
docker-compose up -d

查看应用日志

bash
docker-compose logs -f web

执行数据库迁移

bash
docker exec -it mes-demarches-app bundle exec rails db:migrate

创建超级管理员账户

bash
docker exec -it mes-demarches-app bundle exec rake superadmin:create

执行定时任务

bash
docker exec -it mes-demarches-app bundle exec rails jobs:schedule

更新应用

bash
docker-compose pull
docker-compose down
docker-compose up -d

查看本地发送的邮件

访问 http://localhost:3000/letter_opener 查看应用发送的邮件（仅开发环境）。

执行测试

bash
# 运行所有测试
docker exec -it mes-demarches-app bin/rspec

# 运行特定测试文件
docker exec -it mes-demarches-app bin/rspec spec/path/to/file_spec.rb

# 运行带浏览器界面的系统测试
docker exec -it mes-demarches-app NO_HEADLESS=1 bin/rspec spec/system

开发环境设置

依赖安装

Ubuntu系统依赖

bash
sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev libcurl4-gnutls-dev zlib1g-dev postgresql imagemagick gsfonts redis-server

初始化开发环境

bash
# 克隆代码仓库
git clone https://github.com/your-org/mes-demarches.git
cd mes-demarches

# 初始化环境
bin/setup

# 启动开发服务器
bin/dev

应用将运行在 http://localhost:3000，默认测试用户为 test@exemple.fr，密码为 this is a very complicated password !。

代码质量与测试

代码检查

bash
# 运行所有代码检查工具
docker exec -it mes-demarches-app bin/rake lint

# 检查翻译状态
docker exec -it mes-demarches-app bundle exec i18n-tasks health

测试执行选项

• 运行所有测试：bin/rspec
• 运行特定测试文件：bin/rspec spec/file_path/file_name_spec.rb
• 运行特定行的测试：bin/rspec spec/file_path/file_name_spec.rb:line_number
• 仅重新运行失败的测试：bin/rspec --only-failures
• 显示JavaScript错误日志：JS_LOG=debug,log,error bin/rspec spec/system
• 增加端到端测试延迟：MAKE_IT_SLOW=1 bin/rspec spec/system

性能监控

应用集成了多种性能监控工具：

• Skylight：应用性能监控，访问 [***] 查看详细数据
• Prometheus指标导出：设置 PROMETHEUS_EXPORTER_ENABLED=true 启用
• Yabeda：Sidekiq性能指标收集

许可证信息

Mes-Démarches基于AGPL开源许可证，是démarches-simplifiees.fr项目的衍生作品。Lightgallery组件需要相应的许可授权，开源项目使用可豁免许可费用。