swipl/swish

SWISH (SWI-Prolog for SHaring) Docker镜像

镜像概述

本镜像基于官方SWI-Prolog Docker镜像构建，提供SWISH（SWI-Prolog for SHaring）Web服务器，支持在浏览器中运行SWI-Prolog代码。

核心功能与特性

• 提供Web界面，实现浏览器中运行SWI-Prolog代码的能力
• 支持多场景配置，通过Docker选项和入口点参数灵活控制
• 数据持久化存储，通过/data卷管理配置、用户数据及证书
• 多种认证模式：完全认证（always）、社交登录（social）、***访问（anon）
• 支持HTTPS协议，可自动生成自签名证书
• 可集成R服务，通过--with-R选项连接R Docker镜像

使用场景与适用范围

适用于需要在浏览器环境中运行、演示或共享SWI-Prolog代码的场景，如Prolog教学、代码协作、快速原型开发等。

构建镜像

通过以下命令构建镜像：

bash
make image

运行镜像

使用swish.sh脚本

提供swish.sh脚本简化常见运行流程，自动生成docker run命令。基本用法：

bash
./swish.sh [选项] [镜像入口点选项...]

脚本选项

• --port=N：修改端口映射为-p N:3050，默认3050
• --data=dir：挂载指定目录为数据卷，默认当前工作目录
• --with-R[=from]：添加--volumes-from from（from默认rserve），连接R Docker镜像
• -n：仅打印将要执行的docker命令，不实际运行
• -d：后台运行（detached模式）
• -it：传递交互式终端参数

未明确指定的选项将直接传递给镜像入口点。

直接使用docker run

基本运行命令（默认配置）：

bash
docker run -p 3050:3050 -v $(pwd):/data swish

指定端口和数据目录：

bash
docker run -p 8080:3050 -v /path/to/data:/data swish

数据管理

镜像通过/data卷存储所有持久化数据，包含以下关键目录/文件：

• config-enabled：配置文件目录，初始不存在时自动创建并填充默认配置，文件权限与卷根目录一致
• data：动态用户数据目录，不存在时自动创建，所有者为daemon.daemon，服务器以此身份运行
• https：HTTPS证书存储目录，使用--https选项时创建，包含server.crt（证书）和server.key（密钥），无证书时自动生成自签名证书
• passwd：认证模式下的用户密码哈希文件，存储用户认证信息

网络访问

容器内服务器默认监听端口3050：

• 未指定--https时启动HTTP服务器
• 使用docker run ... swish --https时启动HTTPS服务器

入口点

容器入口点为/entry.sh，负责初始化数据卷并启动服务器，支持以下选项：

• --bash：启动bash shell而非服务器，shell退出后容器终止
• --help：输出简短帮助信息

配置管理

SWISH配置通过config-enabled目录文件控制，可使用以下命令管理配置：

bash
docker run -it swish [配置选项...] [--run]

• 未指定--run时，配置完成后容器停止；指定--run则配置后自动启动服务器
• 支持同时传递多个配置选项更新多项配置

配置选项详情

• --list-config：列出已安装和可用的配置项，已安装项会标注是否被修改

• --auth=type：修改认证模式，type可选值：

  • always：完全认证模式，强制用户登录并允许执行任意命令。首次配置需交互式运行（docker run -it）以创建初始用户，新增用户使用docker run -it swish --add-user
  • social：社交登录模式，默认启用HTTP登录、Google登录和StackOverflow登录，需分别编辑config-enabled/auth_google.pl和config-enabled/auth_stackoverflow.pl完成配置
  • anon（或anonymous）：默认模式，完全***访问，仅执行沙盒化Prolog查询

• --add-config file ...：从可用配置目录复制一个或多个配置文件到config-enabled

• --add-user：添加HTTP认证用户，交互式提示输入用户名、***、组（建议填users）和密码

• --https：启用HTTPS服务器，使用https目录证书（无证书时生成自签名证书）。可通过--CN=host（主机名）、--O=organization（组织）、--C=country（国家）自定义证书信息

部署示例

基本启动（默认端口3050，当前目录为数据卷）

bash
./swish.sh

指定端口和数据目录并后台运行

bash
./swish.sh --port=8080 --data=/opt/swish-data -d

配置为HTTPS模式并启动

bash
docker run -p 443:3050 -v /path/to/data:/data swish --https

配置完全认证模式并启动服务器

bash
docker run -it -p 3050:3050 -v /path/to/data:/data swish --auth=always --run

添加新认证用户

bash
docker run -it -v /path/to/data:/data swish --add-user