{"id":22386909,"url":"https://github.com/qnimbus/hass-dev-container","last_synced_at":"2025-03-26T20:45:06.427Z","repository":{"id":37883507,"uuid":"360497738","full_name":"QNimbus/hass-dev-container","owner":"QNimbus","description":"HASS Docker container for development \u0026 testing","archived":false,"fork":false,"pushed_at":"2023-03-28T03:48:19.000Z","size":19,"stargazers_count":1,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-01T02:41:53.238Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QNimbus.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},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://paypal.me/BasvanWetten"]}},"created_at":"2021-04-22T11:39:57.000Z","updated_at":"2023-01-01T09:13:32.000Z","dependencies_parsed_at":"2023-02-12T20:45:31.287Z","dependency_job_id":null,"html_url":"https://github.com/QNimbus/hass-dev-container","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QNimbus%2Fhass-dev-container","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QNimbus%2Fhass-dev-container/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QNimbus%2Fhass-dev-container/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QNimbus%2Fhass-dev-container/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QNimbus","download_url":"https://codeload.github.com/QNimbus/hass-dev-container/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245734107,"owners_count":20663637,"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":[],"created_at":"2024-12-05T02:07:07.003Z","updated_at":"2025-03-26T20:45:06.398Z","avatar_url":"https://github.com/QNimbus.png","language":"Shell","funding_links":["https://paypal.me/BasvanWetten"],"categories":[],"sub_categories":[],"readme":"# HASS Docker container for development \u0026 testing \u003c!-- omit in toc --\u003e\n\n![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/QNimbus/hass-dev-container/Publish%20to%20Docker%20registry/main?style=for-the-badge)\n\n- [About](#about)\n- [Usage](#usage)\n  - [Environment Variables](#environment-variables)\n  - [About Lovelace plugins](#about-lovelace-plugins)\n  - [Container script](#container-script)\n  - [Basic configuration](#basic-configuration)\n  - [VSCode 'devcontainer.json' example](#vscode-devcontainerjson-example)\n- [Troubleshooting](#troubleshooting)\n- [Changelog](#changelog)\n\n## About\n\nTODO\n\n## Usage\n\n```bash\ndocker run --rm -it \\\n    --name hass-dev-container \\\n    -p 5000:8123 \\\n    -v $(pwd):/workspaces/test \\\n    -v $(pwd):/config/www/workspace \\\n    -e LOVELACE_LOCAL_FILES=\"\" \\\n    -e LOVELACE_PLUGINS=\"\" \\\n    qnimbus/hass-dev-container\n```\n\n### Environment Variables\n\n| Name                   | Description                                                               | Default |\n| ---------------------- | ------------------------------------------------------------------------- | ------- |\n| `HASS_USERNAME`        | The username of the default user                                          | `hass`  |\n| `HASS_PASSWORD`        | The password of the default user                                          | `hass`  |\n| `LOVELACE_PLUGINS`     | List of lovelace plugins to download from GitHub                          | ''      |\n| `LOVELACE_LOCAL_FILES` | List of filenames in `/config/www/workspace` to add as Lovelace resources | ''      |\n\n### About Lovelace plugins\n\n`LOVELACE_PLUGINS` should be a space separated list of author/repo pairs, e.g. `\"thomasloven/lovelace-card-mod  kalkih/mini-media-player\"`\n`LOVELACE_LOCAL_FILES` is for the currently worked on plugins and should be a list of file names which are mounted in `/config/www/workspace`.\n\n### Container script\n\nSet up and launch Home Assistant\n\n```bash\n$ container.sh\n```\n\nPerform download and setup parts but do not launch Home Assistant\n\n```bash\n$ container.sh setup\n```\n\nLaunch Home Assistant with `hass -c /config -v`\n\n```bash\n$ container.sh launch\n```\n\n### Basic configuration\n\nBasic `configuration.yaml`\n\n```yaml\n# Configure a default setup of Home Assistant (frontend, api, etc)\ndefault_config:\n\n# Text to speech\ntts:\n  - platform: google_translate\n\ngroup: !include groups.yaml\nautomation: !include automations.yaml\nscript: !include scripts.yaml\nscene: !include scenes.yaml\n```\n\n### VSCode 'devcontainer.json' example\n\nWithout existing `configuration.yaml`:\n\n```json\n{\n  \"image\": \"qnimbus/hass-dev-container\",\n  \"postCreateCommand\": \"sudo -E /usr/bin/container.sh setup \u0026\u0026 npm add\",\n  \"forwardPorts\": [8123],\n  \"mounts\": [\n    \"source=${localWorkspaceFolder},target=/config/www/workspace,type=bind\"\n  ]\n}\n```\n\nWith existing `configuration.yaml`:\n\n```json\n{\n  \"image\": \"qnimbus/hass-dev-container\",\n  \"postCreateCommand\": \"sudo -E /usr/bin/container.sh setup \u0026\u0026 npm add\",\n  \"forwardPorts\": [8123],\n  \"mounts\": [\n    \"source=${localWorkspaceFolder},target=/config/www/workspace,type=bind\",\n    \"source=${localWorkspaceFolder}/test,target=/config/test,type=bind\",\n    \"source=${localWorkspaceFolder}/test/configuration.yaml,target=/config/configuration.yaml,type=bind\"\n  ],\n  \"runArgs\": [\"--env-file\", \"${localWorkspaceFolder}/test/.env\"]\n}\n```\n\n## Troubleshooting\n\nWhen running the docker commands from a Windows Git Bash shell (MSYS) you may need to prepend the `MSYS_NO_PATHCONV=1` environment variable to the commands like so:\n\n```bash\nMSYS_NO_PATHCONV=1 docker run --rm -it \\\n    --name hass-dev-container \\\n    -p 5000:8123 \\\n    -v ${PWD}:/workspaces/test \\\n    -v ${PWD}:/config/www/workspace \\\n    -e LOVELACE_LOCAL_FILES=\"\" \\\n    -e LOVELACE_PLUGINS=\"\" \\\n    qnimbus/hass-dev-container\n```\n\n## Changelog\n\n### [Unreleased] \u003c!-- omit in toc --\u003e\n\n### [v0.0.2] - 2021-04-26 \u003c!-- omit in toc --\u003e\n\n#### Added \u003c!-- omit in toc --\u003e\n\n- Status badge to README\n- Basic configuration example for Home Assistant\n- Added vscode `tasks.json` file\n- Added vscode `settings.json` file\n- Added `build.sh` script for testing Docker build\n\n#### Changed \u003c!-- omit in toc --\u003e\n\n- Fixed typos in example scripts of README\n- Updated formatting of README\n- Makefile default goal to 'build' instead of 'all'\n\n### [v0.0.1] - 2021-04-21 \u003c!-- omit in toc --\u003e\n\n#### Added \u003c!-- omit in toc --\u003e\n- Initial version of `hass-dev-container` repository\n\n[Unreleased]: https://github.com/qnimbus/hass-dev-container/compare/v0.0.2...HEAD\n[v0.0.2]: https://github.com/qnimbus/hass-dev-container/releases/tag/v0.0.2\n[v0.0.1]: https://github.com/qnimbus/hass-dev-container/releases/tag/v0.0.1\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqnimbus%2Fhass-dev-container","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqnimbus%2Fhass-dev-container","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqnimbus%2Fhass-dev-container/lists"}