Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zocker-160/sheepit-docker-webui

A lightweight docker container for the SheepIt! render farm with WebUI with CUDA support
https://github.com/zocker-160/sheepit-docker-webui

docker-image gui nvidia nvidia-cuda nvidia-docker sheepit webui

Last synced: 2 months ago
JSON representation

A lightweight docker container for the SheepIt! render farm with WebUI with CUDA support

Awesome Lists containing this project

README

        

# A simple dockerized SheepIt render farm client with webUI and CUDA support

**in order to update the sheepit client itself, you only need to restart the container, it will download the latest version on startup**

## Instructions
#### CPU

```bash
docker run \
--name "Sheepit Client" \
--hostname "Docker webUI" \
-p 5800:5800 \
-p 5900:5900 \
zocker160/sheepit-docker-webui
```

#### GPU

In order to make this image work, you need

- Docker >= 19.03
- Nvidia GPU driver
- `nvidia-docker2`

An official guide by Nvidia can be found [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html).

```bash
docker run \
--name "Sheepit Client" \
--hostname "Docker webUI" \
--gpus all \
-p 5800:5800 \
-p 5900:5900 \
zocker160/sheepit-docker-webui
```

**NOTE:** the tag `nvidia-legacy` is can be used for older Nvidia GPUs prior to Pascal and CUDA <= 11.0.

#### Use custom sheepit.jar file (for beta testing for example)

Set `BETA_CHANNEL` to `true` and `DOWNLOAD_URL` to the URL which links to a jar file, which can be downloaded.

##### Optional ENV variables `-e `:

- `USER_NAME`: Sheepit username
- `USER_PASSWORD`: Sheepit render key ([generate one](https://www.sheepit-renderfarm.com/account.php?mode=profile_edit))
- `cpu`: override autodetection; like `-e cpu=4`.
- `UI_MODE`: when set to `DARK`, the webUI will be set into dark mode; options: `LITE`/`DARK`; default: `DARK`
- `APP_NAME`: specify the name shown in the webUI header; default: `Sheepit Renderclient`
- `VNC_PASSWORD`: specify a password to connect to the GUI
- `KEEP_APP_RUNNING`: when set to `1`, the application will be automatically restarted if it crashes or if user quits it; default: `0`
- `DISPLAY_HEIGHT`: set height of the window; default: `"900"`
- `DISPLAY_WIDTH`: set width of the window; default: `"500"`

##### You should be able to access the Sheepit-GUI by opening in a web browser:

`http://[HOST IP ADDR]:5800`

##### You can connect with any VNC client of your choise as well:

` [HOST IP ADDR]:5900`

## Extra bits

[Docker Hub page](https://hub.docker.com/r/zocker160/sheepit-docker-webui//)
[GitHub page](https://github.com/zocker-160/sheepit-docker-webUI)

[SheepIt client GitHub repo](https://github.com/laurent-clouet/sheepit-client)
[SheepIt site](https://www.sheepit-renderfarm.com/)