drawpile/listserver

Drawpile会话列表服务器

概述

本服务器提供简单的RESTful API，用于公开列出Drawpile会话。它主要实现两个功能：

1. 接收并列出会话公告（Drawpile主机对话框中的"列出"选项）
2. 代理Drawpile服务器的实时会话列表

列表服务器提供的列表会显示在Drawpile的加入对话框中，也可在网站上展示。

核心功能与特性

主要功能

• 接收并处理Drawpile会话公告
• 代理Drawpile服务器的实时会话列表，提供统一访问接口

列表类型支持

• 公开公告：可公开访问的会话列表
• 私有列表：仅通过房间码访问的会话列表
• 实时服务器会话：从Drawpile服务器获取的实时会话数据

其他特性

• 支持只读模式：当database设为none时，无法手动列出会话，但会显示从服务器直接获取的会话
• 可通过配置整合Drawpile服务器的会话列表（需设置includeServers）

使用场景

适用于Drawpile服务器管理员，需要为用户提供便捷的会话发现方式：

• 供Drawpile客户端用户在"加入"对话框中查看可用会话
• 集成到网站中，展示当前活跃的Drawpile会话
• 管理私有或公开的Drawpile绘画会话访问

安装与运行

安装方式

1. 安装列表服务器：go get github.com/drawpile/listserver
2. 创建配置文件（参考example.cfg）
3. 运行列表服务器：$GOPATH/bin/listserver -c myconfig.cfg

环境变量配置

也可通过环境变量传递配置参数，例如：

bash
LS_LISTEN=localhost:8081 ./listserver

Systemd服务配置

示例systemd单元文件（/etc/systemd/system/drawpile-listserver.service）：

ini
[Unit]
Description=Drawpile会话列表服务器
After=network.target

[Service]
ExecStart=/home/website/go/bin/listserver -c /home/website/listserver.cfg
User=website

[Install]
WantedBy=multi-user.target

配置说明

参考example.cfg获取包含所有可能设置的示例配置，通常只需设置所需选项即可。

关键配置项

列表来源配置

• includeServers：若设置此配置项，列表服务器将使用drawpile-srv的Web管理API获取该服务器的会话列表并纳入结果

运行模式配置

• database：设置为none时，列表服务器将进入只读模式：无法手动列出会话，但会显示从服务器获取的会话（注意：应至少启用一种列表来源，否则服务器无实际功能）

基础配置（必填）

• listen：服务器监听地址
• name：列表服务器的短名称（显示给用户）
• description：服务器的简短描述（显示给用户）
• proxyHeaders=true：建议启用，特别是在使用nginx或apache作为前端时

客户端自动发现

在与drawpile-srv相同域名的/index.html中添加以下meta标签：

html
<meta name="drawpile:list-server" content="https://your-list-server-url-here/">

当用户在Drawpile客户端中选择该服务器并点击"添加"时，客户端将自动获取根索引页面并发现列表服务器。

禁止主机

可通过将主机名添加到hostbans表来禁止其发送会话公告。可选设置过期时间，若为NULL则表示永久禁止。notes列可用于记录禁止原因等备注信息。

与Nginx配合使用

在nginx虚拟主机配置中，添加如下代理传递配置：

nginx
location /listing/ {
    proxy_pass http://127.0.0.1:8080/;
    proxy_redirect default;
    proxy_set_header X-Real-IP $remote_addr;
}

并在列表服务器配置文件中设置：

listen = "127.0.0.1:8080"
proxyHeaders = true

注意：proxyHeaders设置至关重要，因为连接的远程地址将是nginx服务器的地址，必须通过HTTP头传递原始客户端地址。