sheepitrenderfarm/client Docker Image Overview

sheepitrenderfarm/client

sheepitrenderfarm

SheepIt渲染农场的官方Docker客户端镜像，提供文本界面和Web图形界面，用于分布式渲染任务的便捷部署和管理。

16 收藏0 次下载

⏱️ 镜像拉取更稳定，部署项目不再心跳加速

中文简介版本下载

⏱️ 镜像拉取更稳定，部署项目不再心跳加速

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或Docker Hub Tags。

配置说明

用户和组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环境变量：

命令行参数	环境变量	说明
`--help`	`SHEEP_HELP`	设置为`true`激活
`--headless`	`SHEEP_HEADLESS`	设置为`true`激活，默认`true`
`--no-gpu`	`SHEEP_NO_GPU`	设置为`true`激活
`--no-systray`	`SHEEP_NO_SYSTRAY`	设置为`true`激活
`--show-gpu`	`SHEEP_SHOW_GPU`	设置为`true`激活
`--verbose`	`SHEEP_VERBOSE`	设置为`true`激活
`--version`	`SHEEP_VERSION`	设置为`true`激活
`-cache-dir`	`SHEEP_CACHE_DIR`	默认路径为卷`/sheepit/cache`
`-compute-method`	`SHEEP_COMPUTE_METHOD`	-
`-config`	`SHEEP_CONFIG`	-
`-cores`	`SHEEP_CORES`	-
`-extras`	`SHEEP_EXTRA`	-
`-gpu`	`SHEEP_GPU`	-
`-hostname`	`SHEEP_HOSTNAME`	默认值为`SheepIt-Docker`
`-memory`	`SHEEP_MEMORY`	-
`-password`	`SHEEP_PASSWORD`	-
`-priority`	`SHEEP_PRIORITY`	-
`-proxy`	`SHEEP_PROXY`	-
`-rendertime`	`SHEEP_RENDERTIME`	-
`-request-time`	`SHEEP_REQUEST_TIME`	-
`-server`	`SHEEP_SERVER`	-
`-shared-zip`	`SHEEP_SHARED_ZIP`	默认路径为卷`/sheepit/shared-zip`
`-shutdown`	`SHEEP_SHUTDOWN`	-
`-shutdown-mode`	`SHEEP_SHUTDOWN_MODE`	-
`-theme`	`SHEEP_THEME`	GUI默认主题为`dark`
`-title`	`SHEEP_TITLE`	-
`-ui`	`SHEEP_UI`	根据标签默认值为`text`（文本界面）或`swing`（图形界面）

高级配置选项

Docker Compose

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

Nvidia GPU支持

如需启用Nvidia GPU支持，需确保Docker版本≥19.03，主机已安装最新NVIDIA驱动和nvidia-docker2。Nvidia官方安装指南可参考此处。运行容器时需添加--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 \
 #[...]