sheepitrenderfarm/client

SheepIt Client Docker镜像

SheepIt渲染农场客户端的官方Docker镜像，支持文本界面和Web图形界面两种交互方式，便于用户快速部署和管理分布式渲染任务。

文本界面快速启动

以下是文本界面的快速启动示例，需将<login>和<password>替换为您的SheepIt用户名和密码（建议使用渲染密钥）。可通过docker attach sheepit连接容器的文本界面，按Ctrl+P + Ctrl+Q可断开连接（默认退出序列）。

bash
docker run -dit \
 --name sheepit \
 -e SHEEP_LOGIN=<login> \
 -e SHEEP_PASSWORD=<password> \
 sheepitrenderfarm/client:text

Web图形界面快速启动

以下是Web图形界面的快速启动示例，访问http://<host-ip-addr>:5800即可使用类似桌面应用的图形前端。<host-ip-addr>为运行容器的Docker主机IP地址/主机名/FQDN，本地主机可直接访问http://localhost:5800。

bash
docker run -d \
 --name sheepit \
 -p 5800:5800 \
 sheepitrenderfarm/client:gui

镜像标签

文本界面

文本界面（命令行）镜像使用标签text，同时text也是默认标签（即latest标签指向text）。

Web图形界面

Web图形界面（桌面）镜像使用标签gui。

版本特定标签

还提供版本特定标签，例如对于text标签和版本1.2.3，对应标签为text-1.2和text-1.2.3。更多标签信息可参考GitLab Tags或https://hub.docker.com/r/sheepitrenderfarm/client/tags%E3%80%82

配置说明

用户和组ID

如需修改运行用户的UID和GID，可分别通过USER_ID和GROUP_ID环境变量设置，默认值均为1000。

Beta版本

通过设置环境变量BETA=true，可使用客户端的Beta分支。

SheepIt参数

所有SheepIt客户端参数均可通过环境变量控制。如需查看参数说明，可运行docker run --rm -e SHEEP_HELP=true sheepitrenderfarm/client:text。

所有SheepIt环境变量：

高级配置选项

Docker Compose

可参考示例文件docker-compose.yaml或gui-docker-compose.yaml进行配置。

Nvidia GPU支持

如需启用Nvidia GPU支持，需确保Docker版本≥19.03，主机已安装最新https://github.com/NVIDIA/nvidia-docker/wiki/Frequently-Asked-Questions#how-do-i-install-the-nvidia-driver%E5%92%8C%60nvidia-docker2%60%E3%80%82Nvidia%E5%AE%98%E6%96%B9%E5%AE%89%E8%A3%85%E6%8C%87%E5%8D%97%E5%8F%AF%E5%8F%82%E8%80%83%E6%AD%A4%E5%A4%84%E3%80%82%E8%BF%90%E8%A1%8C%E5%AE%B9%E5%99%A8%E6%97%B6%E9%9C%80%E6%B7%BB%E5%8A%A0%60--gpus all`参数：

bash
docker run -d \
 #[...]
 --gpus all \
 #[...]

运行多个SheepIt容器

若在同一主机或集群中运行多个容器，且使用网络共享文件系统，建议共享/sheepit/shared-zip目录。例如，将主机目录/opt/sheepit/shared-zip通过-v /opt/sheepit/shared-zip:/sheepit/shared-zip挂载到容器：

bash
docker run -d \
 #[...]
 -v /opt/sheepit/shared-zip:/sheepit/shared-zip \
 #[...]

此外，可设置DOWNLOAD_ONLY="true"仅下载最新SheepIt客户端JAR文件，将版本信息缓存到/sheepit/client目录后退出。结合NO_AUTOUPDATE="true"可固定客户端版本，便于多容器共享：

bash
docker run \
 --name sheepit \
 -e DOWNLOAD_ONLY="true" \
 sheepitrenderfarm/client:text && \
docker cp -a sheepit:/sheepit/client /opt/sheepit/client

之后可运行多个共享/sheepit/client和/sheepit/shared-zip的容器：

bash
docker run -d \
 #[...]
 -e NO_AUTOUPDATE="true" \
 -v /opt/sheepit/client:/sheepit/client \
 -v /opt/sheepit/shared-zip:/sheepit/shared-zip \
 #[...]

长期运行详细模式

不建议长期设置SHEEP_VERBOSE，若需使用，建议通过--log-opt max-size=10m限制日志文件大小。

Web图形界面特定配置

Web图形界面默认通过5800端口提供HTTP服务，同时支持5900端口的VNC服务。该标签基于https://github.com/jlesage/docker-baseimage-gui/%E9%95%9C%E5%83%8F%EF%BC%8C%E7%9B%B8%E5%85%B3%E9%85%8D%E7%BD%AE%E9%80%89%E9%A1%B9%E5%9D%87%E9%80%82%E7%94%A8%E3%80%82

构建镜像

构建镜像的详细步骤可参考build.sh文件。

链接

https://hub.docker.com/r/sheepitrenderfarm/client

SheepIt GitLab仓库
SheepIt官网

致谢

dapor2000 @https://github.com/dapor2000/sheepit-docker

AGSPhoenix @https://github.com/AGSPhoenix/sheepit-docker

zocker-160 @GitHub仓库 https://github.com/zocker-160/sheepit-docker-webUI 和 https://github.com/zocker-160/sheepit-docker

DaCool @https://github.com/DaCoolX/sheepit-docker