{"id":19096898,"url":"https://github.com/zocker-160/sheepit-docker-webui","last_synced_at":"2025-04-30T14:29:30.560Z","repository":{"id":106358609,"uuid":"149202967","full_name":"zocker-160/sheepit-docker-webUI","owner":"zocker-160","description":" A lightweight docker container for the SheepIt! render farm with WebUI with CUDA support","archived":false,"fork":false,"pushed_at":"2023-09-29T17:27:37.000Z","size":67,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-30T14:29:29.347Z","etag":null,"topics":["docker-image","gui","nvidia","nvidia-cuda","nvidia-docker","sheepit","webui"],"latest_commit_sha":null,"homepage":"https://www.sheepit-renderfarm.com/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zocker-160.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-17T23:57:02.000Z","updated_at":"2024-01-20T16:40:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"6aae0c87-ae67-4972-b61d-c6ebcb310320","html_url":"https://github.com/zocker-160/sheepit-docker-webUI","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zocker-160%2Fsheepit-docker-webUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zocker-160%2Fsheepit-docker-webUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zocker-160%2Fsheepit-docker-webUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zocker-160%2Fsheepit-docker-webUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zocker-160","download_url":"https://codeload.github.com/zocker-160/sheepit-docker-webUI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251721268,"owners_count":21632799,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-image","gui","nvidia","nvidia-cuda","nvidia-docker","sheepit","webui"],"created_at":"2024-11-09T03:38:07.305Z","updated_at":"2025-04-30T14:29:30.536Z","avatar_url":"https://github.com/zocker-160.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# A simple dockerized SheepIt render farm client with webUI and CUDA support\n\n**in order to update the sheepit client itself, you only need to restart the container, it will download the latest version on startup**\n\n## Instructions\n#### CPU\n\n```bash\ndocker run \\\n --name \"Sheepit Client\" \\\n --hostname \"Docker webUI\" \\\n -p 5800:5800 \\\n -p 5900:5900 \\\nzocker160/sheepit-docker-webui\n```\n\n#### GPU\n\nIn order to make this image work, you need \n\n- Docker \u003e= 19.03 \n- Nvidia GPU driver\n- `nvidia-docker2`\n\nAn official guide by Nvidia can be found [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html).\n\n```bash\ndocker run \\\n --name \"Sheepit Client\" \\\n --hostname \"Docker webUI\" \\\n --gpus all \\\n -p 5800:5800 \\\n -p 5900:5900 \\\nzocker160/sheepit-docker-webui\n```\n\n**NOTE:** the tag `nvidia-legacy` is can be used for older Nvidia GPUs prior to Pascal and CUDA \u003c= 11.0.\n\n#### Use custom sheepit.jar file (for beta testing for example)\n\nSet `BETA_CHANNEL` to `true` and `DOWNLOAD_URL` to the URL which links to a jar file, which can be downloaded.\n\n##### Optional ENV variables `-e \u003cvar\u003e`:\n\n- `USER_NAME`: Sheepit username\n- `USER_PASSWORD`: Sheepit render key ([generate one](https://www.sheepit-renderfarm.com/account.php?mode=profile_edit))\n- `cpu`: override autodetection; like `-e cpu=4`.\n- `UI_MODE`: when set to `DARK`, the webUI will be set into dark mode; options: `LITE`/`DARK`; default: `DARK`\n- `APP_NAME`:  specify the name shown in the webUI header; default: `Sheepit Renderclient`\n- `VNC_PASSWORD`: specify a password to connect to the GUI\n- `KEEP_APP_RUNNING`: when set to `1`, the application will be automatically restarted if it crashes or if user quits it; default: `0`\n- `DISPLAY_HEIGHT`: set height of the window; default: `\"900\"`\n- `DISPLAY_WIDTH`: set width of the window; default: `\"500\"`\n\n##### You should be able to access the Sheepit-GUI by opening in a web browser:\n\n`http://[HOST IP ADDR]:5800`\n\n##### You can connect with any VNC client of your choise as well:\n\n` [HOST IP ADDR]:5900`\n\n## Extra bits\n\n[Docker Hub page](https://hub.docker.com/r/zocker160/sheepit-docker-webui//)  \n[GitHub page](https://github.com/zocker-160/sheepit-docker-webUI)\n\n[SheepIt client GitHub repo](https://github.com/laurent-clouet/sheepit-client)  \n[SheepIt site](https://www.sheepit-renderfarm.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzocker-160%2Fsheepit-docker-webui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzocker-160%2Fsheepit-docker-webui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzocker-160%2Fsheepit-docker-webui/lists"}