domjudge/domjudge-contributor

DOMjudge 贡献者 Docker 镜像

镜像概述和主要用途

该镜像适用于希望为 DOMjudge 项目做贡献但不想配置完整安装环境的开发者。它提供了一个预配置的开发环境，使贡献者能够专注于代码开发而非环境配置。

核心功能和特性

包含组件

• 自动安装脚本，可：
  • 从挂载卷设置 DOMjudge 维护者安装环境
  • 设置或更新数据库
  • 配置 Web 服务器
  • 创建 chroot 环境
• PHP-FPM 和 Nginx，用于运行 Web 界面
• 两个使用 chroot 的运行中的 judgedaemon
• Web 服务器和 judgedaemon 日志文件读取脚本
• 创建虚拟 DOMjudge 用户并提交所有测试提交的脚本
• 启用和禁用 Xdebug 的脚本

不包含组件

• MySQL / MariaDB：推荐使用官方 https://hub.docker.com/r/_/mariadb/ Docker 容器
• DOMjudge 源代码：需要在目标机器上克隆 https://github.com/domjudge/domjudge 并创建相应的卷挂载

使用场景和适用范围

该镜像专为 DOMjudge 项目贡献者设计，适用于：

• DOMjudge 核心功能开发
• 新特性测试和验证
• 问题调试和修复
• 本地开发和测试环境搭建

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

镜像获取

该镜像可在 https://hub.docker.com 获取，镜像名称为 domjudge/domjudge-contributor。

前置准备

1. 启动 MariaDB 容器

在启动 DOMjudge 容器前，需要准备 MySQL / MariaDB 数据库。最简单的方法是使用 MariaDB Docker 容器：

bash
docker run -it --name dj-mariadb -e MYSQL_ROOT_PASSWORD=rootpw -e MYSQL_USER=domjudge -e MYSQL_PASSWORD=djpw -e MYSQL_DATABASE=domjudge -p 13306:3306 mariadb --max-connections=1000

此命令会启动一个 MariaDB 容器，设置：

• root 密码为 rootpw
• 创建名为 domjudge 的用户，密码为 djpw
• 创建名为 domjudge 的空数据库
• 在本地机器的 *** 端口暴露服务

若需在容器删除后保留 MySQL 数据，请参考 https://hub.docker.com/r/_/mariadb/ Docker Hub 页面的说明。

2. 启用 cgroups（仅 Linux）

Linux 用户需要确保启用了 cgroups。具体设置方法请参考 DOMjudge 文档中关于 judgehost 配置的部分。Windows 和 macOS 上的 Docker 已在其 Linux 虚拟机中预设了这些选项。

运行 DOMjudge 容器

bash
docker run -v [本地DOMjudge代码路径]:/domjudge -v /sys/fs/cgroup:/sys/fs/cgroup:ro --link dj-mariadb:mariadb -it -e MYSQL_HOST=mariadb -e MYSQL_USER=domjudge -e MYSQL_DATABASE=domjudge -e MYSQL_PASSWORD=djpw -e MYSQL_ROOT_PASSWORD=rootpw -p 12345:80 --name domjudge --privileged domjudge/domjudge-contributor

参数说明：

• 将 [本地DOMjudge代码路径] 替换为你本地克隆的 DOMjudge 仓库路径
• 在最新的 macOS 和 Windows Docker 版本上，建议在 /domjudge 卷后添加 :cached 参数以提高 Web 服务器性能，如：-v [本地DOMjudge代码路径]:/domjudge:cached

容器启动后，会自动设置 DOMjudge 维护者安装环境、配置数据库、创建 chroot 环境，然后启动 nginx、PHP-FPM 和两个 judgedaemon。

访问 Web 界面

Web 界面可通过 http://localhost:***/ 访问。使用用户名 admin 和 etc/initial_admin_password.secret 文件中的密码登录。

注意：DOMjudge 6.0.0 及以上版本的 Web 服务器配置默认使用调试前端控制器。

加载示例数据

默认不加载示例数据，可通过以下命令手动加载：

bash
bin/dj_setup_database install-examples

环境变量

容器支持以下环境变量：

通过文件设置密码

为避免通过环境变量传递敏感信息，可使用 MYSQL_PASSWORD_FILE 和 MYSQL_ROOT_PASSWORD_FILE 变量指定包含密码的文件路径。这适用于与 Docker Compose 的 secrets 功能配合使用：

yaml
services:
    domjudge-contributor:
        image: domjudge/domjudge-contributor:${DOMJUDGE_VERSION}
        secrets:
            - domjudge-mysql-pw
        environment:
            MYSQL_PASSWORD_FILE: /run/secrets/domjudge-mysql-pw

可用命令

可通过以下语法在容器内执行命令：

bash
docker exec -it domjudge [command]

日志查看命令

• nginx-access-log: 查看 nginx 访问日志
• nginx-error-log: 查看 nginx 错误日志
• judgedaemon-log 0 和 judgedaemon-log 1: 查看第一个/第二个 judgeaemon 的日志
• symfony-log: 查看 Symfony 日志（适用于 DOMjudge 6.x 及以上版本）

开发辅助命令

• submit-test-programs: 提交所有测试程序（在 DOMjudge 安装的 tests 目录中执行 make check test-stress），会自动创建 dummy 用户，密码为 dummy
• xdebug-enable: 启用 Xdebug 调试
• xdebug-disable: 禁用 Xdebug 调试

服务管理

获取 bash shell：

bash
docker exec -it domjudge bash

重启服务：

bash
docker exec -it domjudge supervisorctl restart [service]

其中 [service] 可以是 nginx、php、judgedaemon0 或 judgedaemon1。

Xdebug 配置

Xdebug 默认未启用，因为它会显著降低请求处理速度。可通过以下命令启用和禁用：

bash
docker exec -it domjudge xdebug-enable
docker exec -it domjudge xdebug-disable

Xdebug 配置如下：

• xdebug.remote_autostart=1: 无需设置 cookie 或 GET 参数即可启动调试
• xdebug.remote_enable=1: 启用远程调试
• xdebug.remote_host=host.docker.internal: 连接到 Docker 主机进行调试
• xdebug.idekey=IDE: IDE 密钥，需在 IDE 中设置相同的值

访问评测结果

由于 chroot 脚本会将一些特殊设备复制到每个用于评测的 chroot 中，而 Docker 不支持在卷上使用这些特殊设备，因此为 /domjudge/output/judgings 创建了绑定挂载。要访问此目录内容，需通过以下命令进入容器：

bash
docker exec -it domjudge bash

然后导航到该目录。

Docker Compose 部署示例

创建 docker-compose.yml 文件：

yaml
version: '3'

services:
  mariadb:
    image: mariadb
    container_name: dj-mariadb
    environment:
      MYSQL_ROOT_PASSWORD: rootpw
      MYSQL_USER: domjudge
      MYSQL_PASSWORD: djpw
      MYSQL_DATABASE: domjudge
    ports:
      - "13306:3306"
    command: --max-connections=1000
    restart: unless-stopped

  domjudge:
    image: domjudge/domjudge-contributor
    container_name: domjudge
    volumes:
      - [本地DOMjudge代码路径]:/domjudge
      - /sys/fs/cgroup:/sys/fs/cgroup:ro
    environment:
      MYSQL_HOST: mariadb
      MYSQL_USER: domjudge
      MYSQL_PASSWORD: djpw
      MYSQL_ROOT_PASSWORD: rootpw
      MYSQL_DATABASE: domjudge
    ports:
      - "12345:80"
    privileged: true
    depends_on:
      - mariadb
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

镜像源代码

该镜像的源代码可在 https://github.com/DOMjudge/domjudge-packaging/tree/main/docker-contributor/ 中找到。