{"id":20831078,"url":"https://github.com/mvdkleijn/homedash-sidecar","last_synced_at":"2026-04-11T11:02:30.969Z","repository":{"id":173185300,"uuid":"648825508","full_name":"mvdkleijn/homedash-sidecar","owner":"mvdkleijn","description":"Sidecar application used to feed the HomeDash server.","archived":false,"fork":false,"pushed_at":"2025-11-16T21:05:07.000Z","size":81,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-16T23:11:44.832Z","etag":null,"topics":["automation","container","dash","dashboard","docker","docker-compose","go","golang","home-automation","homelab","linux","server"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mvdkleijn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"ko_fi":"chaosmonkey","liberapay":"mvdkleijn"}},"created_at":"2023-06-02T23:14:43.000Z","updated_at":"2025-11-16T20:46:41.000Z","dependencies_parsed_at":"2025-01-18T19:42:22.585Z","dependency_job_id":"1730d843-a4d7-41c5-a13f-3080ddfab160","html_url":"https://github.com/mvdkleijn/homedash-sidecar","commit_stats":null,"previous_names":["mvdkleijn/homedash-sidecar"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/mvdkleijn/homedash-sidecar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvdkleijn%2Fhomedash-sidecar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvdkleijn%2Fhomedash-sidecar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvdkleijn%2Fhomedash-sidecar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvdkleijn%2Fhomedash-sidecar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mvdkleijn","download_url":"https://codeload.github.com/mvdkleijn/homedash-sidecar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mvdkleijn%2Fhomedash-sidecar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31677819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T08:18:19.405Z","status":"ssl_error","status_checked_at":"2026-04-11T08:17:08.892Z","response_time":54,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["automation","container","dash","dashboard","docker","docker-compose","go","golang","home-automation","homelab","linux","server"],"created_at":"2024-11-17T23:26:52.580Z","updated_at":"2026-04-11T11:02:30.964Z","avatar_url":"https://github.com/mvdkleijn.png","language":"Go","funding_links":["https://ko-fi.com/chaosmonkey","https://liberapay.com/mvdkleijn","https://liberapay.com/mvdkleijn/","https://ko-fi.com/O4O7H6C73"],"categories":[],"sub_categories":[],"readme":"# HomeDash sidecar\n\n![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/mvdkleijn/homedash-sidecar?style=for-the-badge)\n[![Go Report Card](https://goreportcard.com/badge/github.com/mvdkleijn/homedash-sidecar?style=for-the-badge)](https://goreportcard.com/report/github.com/mvdkleijn/homedash-sidecar) [![Liberapay patrons](https://img.shields.io/liberapay/patrons/mvdkleijn?style=for-the-badge)](https://liberapay.com/mvdkleijn/) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O4O7H6C73)\n\nThe sidecar application that reports running containers to the HomeDash server.\nIt supports both Docker and Docker Swarm. Easy configuration with only a single\nrequired environment variable, the URL of the server.\n\nKeep in mind that the sidecar application requires access to the Docker API.\n\nSee [HomeDash server](https://github.com/mvdkleijn/homedash) for more details.\n\n## Usage\n\nHomeDash sidecar can run as a standalone binary or as a container.\n\n1) Configure some containers with the HomeDash labels;\n2) Configure the mandatory environment variables;\n3) Start the sidecar;\n\nSee the repository root of [HomeDash server](https://github.com/mvdkleijn/homedash)\nfor an example `compose.yml` using the sidecar.\n\n### Labels used\n\n- `homedash.name=example` (required)\n- `homedash.url=http://my.example.com`\n- `homedash.icon=example`\n- `homedash.comment=Some random comment`\n\nEverything except the `homedash.name` label is optional. Icons are provided by\nthe server and are essentially the same as the ones from Heimdall.\n\n*) when using a custom label prefix, for example \"myprefix\", the label names change\n   accordingly. In our example we'd get `myprefix.name` and `myprefix.url` for instance.\n\n### Label placement\n\nLabels can be placed in two spots. For plain old Docker, including Docker Compose,\nthe labels should be placed on the container level. For Docker Swarm, they can be\nplaced on either the container or service levels. If placed on both, the service\nlevel lables will take precedence.\n\n**Docker Compose example**\n\n```yaml\nservices:\n  myapp:\n    image: XYZ\n    labels:\n      - homedash.name=My App\n      - homedash.url=http://myapp.local/\n      - homedash.icon=myapp\n```\n\n**Docker Swarm example**\n\n```yaml\nservices:\n  myapp:\n    image: XYZ\n    deploy:\n      mode: replicated\n      labels:\n        - homedash.name=My App\n        - homedash.url=http://myapp.local/\n        - homedash.icon=myapp\n```\n\n## Configuration\n\n| Environment variable    | Description                                             | Required | Default value                                   |\n| ----------------------- | ------------------------------------------------------- | -------- | ----------------------------------------------- |\n| `HOMEDASH_SERVER`       | Full URL to HomeDash server **without** trailing slash. | Yes      | -                                               |\n| `HOMEDASH_INTERVAL`     | Interval at which to check for apps.                    | No       | \"10m\"                                           |\n| `HOMEDASH_SIDECAR_UUID` | UUID to identify sidecar instance with.                 | No       | **(re)generated on every restart when missing** |\n| `HOMEDASH_LABEL_PREFIX` | Allows setting a custom prefix for the labels.          | No       | \"homedash\"                                      |\n| `HOMEDASH_LOG_LEVEL`    | Specifies logging level for sidecar application.        | No       | \"INFO\"                                          |\n\n*) interval can be set as for exampple \"10m\", \"5s\" or \"1h\". See https://pkg.go.dev/time#ParseDuration for details.\n\n## Support\n\nSupported Go versions, see: https://endoflife.date/go\nSupported architectures: amd64, arm64\n\nSource code and issues: https://github.com/mvdkleijn/homedash-sidecar\n\n## Licensing\n\nHomeDash sidecar is made available under the [MPL-2.0](https://choosealicense.com/licenses/mpl-2.0/)\nlicense. The full details are available from the [LICENSE](/LICENSE) file.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmvdkleijn%2Fhomedash-sidecar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmvdkleijn%2Fhomedash-sidecar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmvdkleijn%2Fhomedash-sidecar/lists"}