jmessenger/maint-autobuild

802.1维护数据库Web应用镜像

镜像概述和主要用途

本镜像基于GitHub仓库https://github.com/jlm/maint%E6%9E%84%E5%BB%BA%EF%BC%8C%E5%B0%86%E5%8E%9F%E5%9F%BA%E4%BA%8EExcel%E5%B7%A5%E4%BD%9C%E7%B0%BF%E7%9A%84802.1%E7%BB%B4%E6%8A%A4%E6%95%B0%E6%8D%AE%E5%BA%93%E8%BD%AC%E6%8D%A2%E4%B8%BAWeb%E5%BA%94%E7%94%A8%E3%80%82%E5%8E%9FExcel%E5%B7%A5%E4%BD%9C%E7%B0%BF%E4%BE%9D%E8%B5%96%E5%A4%8D%E6%9D%82%E5%85%AC%E5%BC%8F%E7%94%9F%E6%88%90%E9%9D%99%E6%80%81HTML%EF%BC%8C%E7%BB%B4%E6%8A%A4%E5%9B%B0%E9%9A%BE%E4%B8%94%E6%98%93%E5%87%BA%E9%94%99%EF%BC%8C%E6%9C%ACWeb%E5%BA%94%E7%94%A8%E6%8F%90%E4%BE%9B%E6%9B%B4%E4%BE%BF%E6%8D%B7%E7%9A%84%E7%AE%A1%E7%90%86%E6%96%B9%E5%BC%8F%EF%BC%8C%E6%94%AF%E6%8C%81%E6%95%B0%E6%8D%AE%E5%AF%BC%E5%85%A5%E3%80%81%E7%94%A8%E6%88%B7%E8%AE%A4%E8%AF%81%E5%92%8C%E6%9D%83%E9%99%90%E7%AE%A1%E7%90%86%E3%80%82

核心功能和特性

• 数据转换：支持导入Excel维护数据库文件，将传统Excel管理方式迁移至Web平台
• 用户管理：集成用户注册、登录功能，支持管理员权限配置
• Web界面：提供直观的Web界面，便于浏览和管理维护数据库条目
• Docker化部署：支持通过Docker Compose快速部署，简化环境配置
• 可扩展性：支持添加HTTPS和反向代理，实现多应用共存和安全访问

使用场景和适用范围

• 需要将Excel维护数据库转换为Web应用的组织或团队
• 希望简化维护数据库管理流程、减少人工错误的场景
• 需在开发或生产环境快速部署维护数据库Web应用的场景

使用方法和配置说明

前置要求

• 已安装Docker和Docker Compose的环境
• 具备基本的Docker命令操作能力

Docker Compose部署步骤

1. 准备数据库存储

在Docker主机上创建持久化存储目录并配置权限：

bash
sudo mkdir -p /srv/docker/postgresql/data
sudo chmod -R go-rwx /srv
sudo chown 999.root /srv/docker/postgresql/data

2. 配置docker-compose文件

复制仓库中的example-deploy-docker-compose.yml为deploy-docker-compose.yml，并根据需求编辑配置：

yaml
version: '3'
services:
  db:
    image: postgres:9.6
    volumes:
      - /srv/docker/postgresql/data:/var/lib/postgresql/data
    environment:
      - POSTGRES_USER=maintuser
      - POSTGRES_PASSWORD=yourpassword
      - POSTGRES_DB=maint_production
    restart: always

  web:
    image: yourusername/maint_web:latest
    depends_on:
      - db
    environment:
      - DATABASE_URL=postgres://maintuser:yourpassword@db:5432/maint_production
      - SECRET_KEY_BASE=your_generated_secret_key
      - DEVISE_PEPPER=your_generated_pepper
      - COMMITTEE=Your Committee Name
      - VIRTUAL_HOST=maint.example.com  # 仅当使用nginx-proxy时需要
      - LETSENCRYPT_HOST=maint.example.com  # 仅当使用letsencrypt时需要
      - LETSENCRYPT_EMAIL=admin@example.com  # 仅当使用letsencrypt时需要
    restart: always

3. 启动应用

bash
# 前台运行（测试用）
docker-compose -f deploy-docker-compose.yml up

# 后台运行（生产环境）
docker-compose -f deploy-docker-compose.yml up -d

应用初始化需要几分钟时间，完成后可通过http://localhost:80访问。

环境变量说明

添加HTTPS和反向代理

若需实现HTTPS和多应用代理，可使用jwilder/nginx-proxy和jrcs/letsencrypt-nginx-proxy-companion：

1. 准备nginx-proxy环境

bash
sudo mkdir /web/nginx-proxy
sudo chown $USER /web/nginx-proxy
curl https://raw.githubusercontent.com/jwilder/nginx-proxy/master/nginx.tmpl > /web/nginx-proxy/nginx.tmpl

# 应用补丁以避免Let's Encrypt验证文件重定向
wget -Onginx.tmpl.patch https://gist.githubusercontent.com/jlm/f415ce4c99880dead9342b78dfefef53/raw/747aacbdafee1fe1fe0d239314d6e49848103c28/nginx.tmpl.patch
patch /web/nginx-proxy/nginx.tmpl < nginx.tmpl.patch

sudo docker network create nginx-proxy

2. 启动nginx-proxy和letsencrypt容器

bash
sudo docker run -d -p 80:80 -p 443:443 --name nginx-proxy --net nginx-proxy --restart=always \
  -v /web/nginx-proxy:/etc/nginx/certs:ro \
  -v /etc/nginx/vhost.d \
  -v /usr/share/nginx/html \
  -v /var/run/docker.sock:/tmp/docker.sock:ro \
  --label com.github.jrcs.letsencrypt_nginx_proxy_companion.nginx_proxy jwilder/nginx-proxy

sudo docker run -d --name nginx-letsencrypt --net nginx-proxy --restart=always \
  -v /web/nginx-proxy:/etc/nginx/certs:rw \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  --volumes-from nginx-proxy jrcs/letsencrypt-nginx-proxy-companion

3. 重新启动应用

确保deploy-docker-compose.yml中配置了VIRTUAL_HOST、LETSENCRYPT_HOST和LETSENCRYPT_EMAIL，然后重启应用：

bash
docker-compose -f deploy-docker-compose.yml up -d

数据导入准备

导入Excel文件前需进行预处理，以避免导入错误：

1. 保存Excel文件副本
2. 通过文件->信息->检查工作簿->文档属性和个人信息移除非法字符
3. 使用应用中的"Import"菜单导入处理后的Excel文件

管理员用户配置

首次使用需手动配置管理员权限：

1. 注册普通用户并登录
2. 停止应用，进入Rails控制台：

bash
docker-compose -f deploy-docker-compose.yml exec web rails console

3. 执行以下命令（替换为实际***）：

ruby
u = User.where(email: "user@example.com").first
u.admin = true
u.save

4. 重启应用，管理员选项将显示在顶部导航栏