{"id":13567636,"url":"https://github.com/obs-websocket-community-projects/obs-websocket-docker","last_synced_at":"2025-07-23T07:09:19.393Z","repository":{"id":46571879,"uuid":"380033742","full_name":"obs-websocket-community-projects/obs-websocket-docker","owner":"obs-websocket-community-projects","description":"Docker image for OBS","archived":false,"fork":false,"pushed_at":"2023-02-06T07:58:56.000Z","size":18526,"stargazers_count":13,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-04T02:35:12.119Z","etag":null,"topics":["docker","docker-image","obs","obs-studio","obs-websocket","ubuntu"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/obs-websocket-community-projects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-24T19:43:18.000Z","updated_at":"2025-03-07T12:46:34.000Z","dependencies_parsed_at":"2023-02-19T05:31:21.068Z","dependency_job_id":null,"html_url":"https://github.com/obs-websocket-community-projects/obs-websocket-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/obs-websocket-community-projects/obs-websocket-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obs-websocket-community-projects%2Fobs-websocket-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obs-websocket-community-projects%2Fobs-websocket-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obs-websocket-community-projects%2Fobs-websocket-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obs-websocket-community-projects%2Fobs-websocket-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/obs-websocket-community-projects","download_url":"https://codeload.github.com/obs-websocket-community-projects/obs-websocket-docker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obs-websocket-community-projects%2Fobs-websocket-docker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266634019,"owners_count":23959681,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","docker-image","obs","obs-studio","obs-websocket","ubuntu"],"created_at":"2024-08-01T13:02:37.289Z","updated_at":"2025-07-23T07:09:19.369Z","avatar_url":"https://github.com/obs-websocket-community-projects.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"![Latest/Nightly](https://github.com/obs-websocket-community-projects/obs-websocket-docker/actions/workflows/docker-latest.yml/badge.svg)\n\n# OBS-Websocket-Docker\n\nDocker image that runs OBS with Palakis OBS Websocket installed.\n\n**Only obs-websocket version 5.0.0 and higher is supported.**\n**This uses the ubuntu / amd64 distribution**\n\nYou can use this in GitHub Actions or your local PC, but it may not work on your Raspberry Pi.\n\n## Running\n\nTo start the container with generic docker:\n\n```sh\ndocker run -p 4455:4455 obswebsocketcommunity/docker:latest\n```\n\nA compose file is also available in this repository as an example:\n\n```sh\ndocker-compose up\n```\n\nThe compose-file will run the latest image of `obswebsocketcommunity/docker:latest`, with the default build args and environment variables (see [Configuration](#Configuration)).\n\nTo take down the docker-compose container:\n\n```sh\ndocker-compose down\n\n# Optionally remove built image so you can rebuild it\ndocker-compose down --rmi local\n```\n\n## Configuration\n\n### Environment Variables\n\n| Env Variable | Description                                         | Default    |\n| ------------ | --------------------------------------------------- | ---------- |\n| OBS_PORT     | Port where obs-websocket listens for connections.\\* | `4455`     |\n| OBS_PASS     | Password for authenticating against obs-websocket   | `password` |\n\n\\*Remember to expose the port too, e.g. `docker run -e OBS_PORT=4545 -p 4545:4545 ...`\n\n### Build Arguments\n\n| Build Argument     | Description             | Default |\n| ------------------ | ----------------------- | ------- |\n| OBS_STUDIO_VERSION | Version of OBS Studio\\* | `28.*`  |\n\n\\* You can search available versions in Ubuntu via `apt list -a obs-studio`\n\n## Building\n\n### Automated Builds\n\nCI/CD Runs daily, at midnight.\nThe images are the following:\n- OBS WebSocket Authentication Enabled\n  - `obswebsocketcommunity/docker:latest`\n  - `obswebsocketcommunity/docker:$timestamp` \n- OBS WebSocket Authentication Disabled\n  - `obswebsocketcommunity/docker:latest-unsecured`\n  - `obswebsocketcommunity/docker:$timestamp-unsecured`\n\n### Manual Builds\n\nUsing build_local.sh you can build a local image.\n\nUsage:\n\n```sh\n./build_local.sh [--unsecured] [obs_version] [repository] [tag]\n```\n\nOptions:\n| Option        | Description             | Default                        |\n| ------------- | ----------------------- | ------------------------------ |\n| `--unsecured` | Disable authentication  |                                |\n| `obs_version` | OBS version\\*           | `28.*`                         |\n| `repository`  | Docker image repository | `obswebsocket-local`           |\n| `tag`         | Docker image tag        | `latest` or `latest-unsecured` |\n\n\\* You can search available versions in Ubuntu via `apt list -a obs-studio`\n\n#### Authentication enabled\n\n```sh\n./build_local.sh\ndocker run -p 4455:4455 obswebsocket-local:latest\n```\n\n#### Authentication disabled\n\n```sh\n./build_local.sh --unsecured\ndocker run -p 4455:4455 obswebsocket-local:latest-unsecured\n```\n\n#### Different OBS version\n\n```sh\n./build_local.sh 28.0.0\ndocker run -p 4455:4455 obswebsocket-local:latest-unsecured\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobs-websocket-community-projects%2Fobs-websocket-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fobs-websocket-community-projects%2Fobs-websocket-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobs-websocket-community-projects%2Fobs-websocket-docker/lists"}