freelawproject/courtlistener

CourtListener Docker镜像文档

一、镜像概述和主要用途

CourtListener Docker镜像是基于CourtListener平台构建的容器化部署方案，旨在提供一个便捷、可移植的方式运行CourtListener系统。CourtListener是一个致力于提升系统透明度与可访问性的开源平台，通过聚合、索引和展示公开数据，帮助用户高效获取法院案例、文书及相关信息。该镜像封装了CourtListener应用程序及其依赖组件，简化了部署流程，适用于各类需要快速搭建***信息检索与分析环境的场景。

二、核心功能和特性

2.1 核心功能

• ***文档全文检索：支持法院案例、判决文书、***意见书等文本的全文检索，提供关键词、日期、法院层级等多维度筛选。
• 案例数据聚合与更新：自动同步公开***数据源（如美国联邦法院、州法院公开数据），确保案例信息实时性与完整性。
• 公开信息API**：提供标准化API接口，支持第三方应用集成，实现**数据的程序化访问与分析。
• 用户友好的交互界面：包含Web前端界面，支持案例可视化分析、历史数据对比及自定义收藏功能。

2.2 镜像特性

• 容器化部署：基于Docker构建，隔离应用依赖，简化环境配置，支持跨平台运行（Linux、Windows、macOS）。
• 可扩展性：支持通过环境变量自定义配置，适配不同规模的部署需求（单机测试、生产集群）。
• 轻量化设计：优化镜像体积，减少冗余依赖，提升启动速度与运行效率。
• 安全合规：遵循数据隐私规范，默认开启基础安全防护（如请求频率限制、敏感数据脱敏）。

三、使用场景和适用范围

3.1 主要使用场景

• 从业者工具：律师、法官等从业者用于快速检索案例、研究判例趋势。
• 学术与政策研究：高校、研究机构分析***体系演变、司法决策模式。
• 公众信息获取**：普通用户查询公开法院信息，提升**知识普及度。
• 开发者集成：第三方应用通过API接入数据，构建科技工具（如案例预测、合规分析）。

3.2 适用范围

• 操作系统：支持Docker的Linux（x86_64/arm64）、Windows、macOS。
• 部署规模：个人本地测试、小型团队内部使用、中型服务集群（需配合外部数据库与缓存）。

四、使用方法和配置说明

4.1 前提条件

• 已安装Docker Engine（20.10+）及Docker Compose（2.0+）。
• 网络环境可访问Docker Hub（用于拉取镜像）及公开***数据源（用于数据同步）。
• 若需持久化数据，建议配置外部存储（如Docker Volume或绑定宿主机目录）。

4.2 基本使用流程

1. 拉取镜像
   从Docker Hub或私有仓库拉取CourtListener镜像：

   bash
   docker pull docker.xuanyuan.run/courtlistener/courtlistener:latest  # 官方镜像示例
   

2. 运行容器
   通过docker run命令启动容器，指定必要配置（端口、环境变量等）：

   bash
   docker run -d \
     --name courtlistener \
     -p 8000:8000 \
     -e DATABASE_URL="postgresql://user:password@db-host:5432/courtlistener" \
     -e SECRET_KEY="your-secure-secret-key" \
     -v ./data:/app/data \
     docker.xuanyuan.run/courtlistener/courtlistener:latest
   

3. 访问服务
   容器启动后，通过http://localhost:8000访问CourtListener Web界面，或通过http://localhost:8000/api调用API。

五、部署示例

5.1 Docker Run快速部署

适用于本地测试或单节点轻量部署：

bash
docker run -d \
  --name courtlistener \
  --restart always \
  -p 8000:8000 \  # Web界面与API端口
  -p 5000:5000 \  # 数据同步服务端口（若启用）
  -e DATABASE_URL="postgresql://courtlistener:pass@postgres:5432/courtlistener" \  # 外部PostgreSQL数据库
  -e SECRET_KEY="AeSh3klo9xQz2pRt" \  # 应用加密密钥（必填，建议自定义）
  -e API_RATE_LIMIT="100/minute" \  # API请求频率限制
  -e LOG_LEVEL="INFO" \  # 日志级别（DEBUG/INFO/WARNING/ERROR）
  -v courtlistener_data:/app/data \  # 持久化数据目录（案例缓存、用户上传文件等）
  courtlistener/courtlistener:latest

5.2 Docker Compose集群部署

适用于生产环境，集成数据库、缓存等依赖组件：

yaml
version: '3.8'

services:
  courtlistener:
    image: docker.xuanyuan.run/courtlistener/courtlistener:latest
    container_name: courtlistener
    restart: always
    ports:
      - "8000:8000"  # Web/API端口
      - "5000:5000"  # 数据同步端口
    environment:
      - DATABASE_URL="postgresql://courtlistener:pass@postgres:5432/courtlistener"
      - SECRET_KEY="your-secure-secret-key"  # 替换为随机生成的安全密钥
      - REDIS_URL="redis://redis:6379/0"  # Redis缓存地址
      - API_KEY="your-api-key"  # 第三方数据源API密钥（如需要）
      - LOG_LEVEL="INFO"
      - ALLOWED_HOSTS="localhost,your-domain.com"  # 允许访问的域名
    volumes:
      - courtlistener_data:/app/data  # 数据持久化
    depends_on:
      - postgres
      - redis

  postgres:
    image: docker.xuanyuan.run/postgres:14-alpine
    container_name: courtlistener-db
    restart: always
    environment:
      - POSTGRES_USER=courtlistener
      - POSTGRES_PASSWORD=pass
      - POSTGRES_DB=courtlistener
    volumes:
      - postgres_data:/var/lib/postgresql/data

  redis:
    image: docker.xuanyuan.run/redis:alpine
    container_name: courtlistener-redis
    restart: always
    volumes:
      - redis_data:/data

volumes:
  courtlistener_data:
  postgres_data:
  redis_data:

启动部署：

bash
docker-compose up -d  # 后台启动所有服务
docker-compose logs -f  # 查看实时日志

六、配置参数说明

6.1 核心环境变量

6.2 数据持久化

• 容器内数据路径：/app/data（存储案例缓存、用户上传文件、日志等），建议通过-v挂载宿主机目录或Docker Volume持久化。

6.3 端口说明

• 8000/tcp：Web界面与API服务端口（必需映射）。
• 5000/tcp：数据同步服务端口（仅需映射若需外部触发同步）。

七、注意事项

1. 数据库依赖：CourtListener需PostgreSQL数据库支持，生产环境建议使用外部独立数据库（而非容器内数据库）以提升稳定性。
2. 数据同步：首次启动后需等待数据初始化（可能耗时较长，取决于网络与数据源响应速度）。
3. 安全配置：SECRET_KEY需使用强随机字符串，生产环境建议通过Docker Secrets或环境变量文件注入，避免明文暴露。
4. 性能优化：大规模部署时建议配置Redis缓存、数据库连接池，并调整DATA_SYNC_INTERVAL减少资源占用。