Skip to content
This repository has been archived by the owner on Feb 20, 2024. It is now read-only.

My highly opinionated configuration for my Home Assistant instance. This manages integrating all the IoT devices in my home.

License

Notifications You must be signed in to change notification settings

alexwaibel/home-assistant-config

Repository files navigation


Home Assistant Config

My personal home automation configuration.

Report Bug · Request Feature

Forks Stargazers Issues GPL License

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Acknowledgments

About The Project

This repository contains the full configuration for my Home Assistant instance running on my home cluster. You can find more information about this in the cluster repo.

Built With

Getting Started

Below are instructions for setting up your development environment. I use a container running code-server with access to the volume storing my config.

  1. Open this configuration using the code-server container or GitHub codespaces
  2. Make changes to configuration
  3. Use the Home Assistant UI or VS Code extension to validate the config
  4. Reboot Home Assistant via UI to apply changes

Prerequisites

Install the necessary tools and pre-commit hooks so you can ensure your changes the checks.

  • markdownlint

    npm install -g markdownlint-cli
  • yamllint

    pip install --user yamllint
  • pre-commit

    pip install --user pre-commit

Then install the hooks

pre-commit install

Installation

  1. Log in to your Home Assistant machine

  2. Set your secret environment variables

  3. Clone the repo

    git clone https://github.com/alexwaibel/home-assistant-config.git
  4. Add the font .otf files to /www/fonts

  5. Restart Home Assistant

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GPL License. See LICENSE.md for more information.

Acknowledgments

A big thanks to all the authors of the projects that make this setup possible.

About

My highly opinionated configuration for my Home Assistant instance. This manages integrating all the IoT devices in my home.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published