openstates.org Docker镜像文档

一、镜像概述

openstates.org Docker镜像是用于部署openstates.org网站及API服务的容器化解决方案。该镜像基于openstates.org***代码仓库构建，旨在提供美国各州立法数据的公开访问服务，包括立法机构信息、法案文本、投票结果、立法者资料等数据的查询与展示。

二、核心功能与特性

2.1 核心功能

• 立法数据API服务：提供RESTful API接口，支持查询美国50个州及华盛顿特区的立法机构、法案、投票记录、立法者等数据。
• 网站用户界面：提供直观的Web界面，供用户浏览、搜索和筛选立法数据。
• 数据自动更新：集成数据同步机制，定期从各州***数据源更新立法信息。
• 多格式数据输出：支持JSON、CSV等多种数据格式，满足不同场景需求。

2.2 关键特性

• 轻量级部署：基于容器化架构，简化依赖管理与环境配置。
• 可扩展性：支持水平扩展，适应不同访问量需求。
• 数据持久化：支持外部卷挂载，确保数据更新与存储独立于容器生命周期。
• 配置灵活：通过环境变量自定义服务参数，如数据库连接、缓存策略等。

三、使用场景与适用范围

3.1 主要场景

• 开发者集成：第三方应用通过API获取立法数据，开发立法追踪工具、政策分析平台等。
• 研究与分析：学术机构、政策研究团队批量获取数据，进行立法趋势分析、利益集团影响研究等。
• 公众教育：学校、非营利组织通过网站向公众普及州级立法流程与透明度。

3.2 适用范围

• 需要美国州级立法数据的个人开发者、企业开发者。
• 从事公共政策、***研究的学术机构或非营利组织。
• 对***透明度、立法过程感兴趣的教育机构或公众。

四、使用方法与配置说明

4.1 基础依赖

• Docker Engine 20.10+
• Docker Compose 2.0+（如需编排）
• 至少2GB内存（推荐4GB+，数据同步时内存需求较高）

4.2 环境变量配置

通过环境变量自定义服务行为，关键变量如下表：

4.3 卷挂载

为确保数据持久化（如同步的立法数据、日志），需挂载以下目录：

4.4 端口映射

容器默认暴露Web服务端口 8000，需映射至宿主机端口（如 80 或 8000）。

五、Docker部署方案示例

5.1 单容器部署（docker run）

bash
docker run -d \
  --name openstates \
  -p 8000:8000 \
  -e DATABASE_URL="postgresql://user:pass@db-host:5432/openstates" \
  -e REDIS_URL="redis://redis-host:6379/0" \
  -e SECRET_KEY="your-secure-secret-key" \
  -e ALLOWED_HOSTS="your-domain.com,localhost" \
  -v /local/data:/app/data \
  -v /local/logs:/app/logs \
  openstates/openstates.org:latest

5.2 多容器编排（docker-compose.yml）

yaml
version: '3.8'

services:
  web:
    image: openstates/openstates.org:latest
    ports:
      - "8000:8000"
    environment:
      - DATABASE_URL=postgresql://postgres:postgres@db:5432/openstates
      - REDIS_URL=redis://redis:6379/0
      - SECRET_KEY=your-secure-secret-key
      - ALLOWED_HOSTS=localhost,127.0.0.1,your-domain.com
      - DEBUG=False
      - DATA_SYNC_INTERVAL=12
    volumes:
      - ./data:/app/data
      - ./logs:/app/logs
      - ./static:/app/static
    depends_on:
      - db
      - redis
    restart: unless-stopped

  db:
    image: postgres:14-alpine
    volumes:
      - postgres_data:/var/lib/postgresql/data/
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=openstates
    restart: unless-stopped

  redis:
    image: redis:alpine
    volumes:
      - redis_data:/data
    restart: unless-stopped

volumes:
  postgres_data:
  redis_data:

启动命令：

bash
docker-compose up -d

六、数据同步与维护

6.1 手动触发数据同步

bash
# 进入容器
docker exec -it openstates bash

# 执行同步命令
python manage.py sync_data --all-states

6.2 日志查看

bash
# 查看应用日志
tail -f /path/to/logs/app.log

# 查看Docker容器日志
docker logs -f openstates

七、相关链接

• 问题反馈
• 社区讨论
• 贡献指南
• 部署文档
• 行为准则