core Documentation

1. Project Overview & Quickstart (home-assistant/core) Copy Chapter

File: README.rst Copy Chapter

Home Assistant |Chat Status|

Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.

Check out home-assistant.io <https://home-assistant.io>__ for a demo <https://demo.home-assistant.io>, installation instructions <https://home-assistant.io/getting-started/>,
tutorials <https://home-assistant.io/getting-started/automation/>__ and documentation <https://home-assistant.io/docs/>__.

|screenshot-states|

Featured integrations Copy Chapter

|screenshot-integrations|

The system is built using a modular approach so support for other devices or actions can be implemented easily. See also the section on architecture <https://developers.home-assistant.io/docs/architecture_index/>__ and the section on creating your own components <https://developers.home-assistant.io/docs/creating_component_index/>__.

If you run into issues while using Home Assistant or during development
of a component, check the Home Assistant help section <https://home-assistant.io/help/>__ of our website for further help and information.

|ohf-logo|

.. |Chat Status| image:: https://img.shields.io/discord/330944238910963714.svg
:target: https://www.home-assistant.io/join-chat/
.. |screenshot-states| image:: https://raw.githubusercontent.com/home-assistant/core/dev/.github/assets/screenshot-states.png
:target: https://demo.home-assistant.io
.. |screenshot-integrations| image:: https://raw.githubusercontent.com/home-assistant/core/dev/.github/assets/screenshot-integrations.png
:target: https://home-assistant.io/integrations/
.. |ohf-logo| image:: https://www.openhomefoundation.org/badges/home-assistant.png
:alt: Home Assistant - A project from the Open Home Foundation
:target: https://www.openhomefoundation.org/

2. Official Technical Reference & Guides (home-assistant/home-assistant.github.io) Copy Chapter

Home Assistant website

This is the source for the Home-Assistant.io website.

Access Copy Chapter

You can access the site at the following URLs, depending on the target branch:

• Production (current branch): https://www.home-assistant.io
• Beta (rc branch): https://rc.home-assistant.io
• Development (next branch): https://next.home-assistant.io

Additionally, Netlify provides a preview deployment for every pull request, linked in the first PR comment.

Setup Copy Chapter

Setting up to contribute to documentation and the process for submitting pull requests is explained in the developer documentation.

Site preview Copy Chapter

In order to make the preview available on http://127.0.0.1:4000, use the following bundler command:

bundle exec rake preview

If the preview is not running on your local machine, pass the IP of the target machine from where it should be served as a parameter, i.e. to access on http://192.168.0.123:4000:

bundle exec rake preview[192.168.0.123]

Speeding up site generation Copy Chapter

Every release we post long changelogs to the website. This slows down generation of the website significantly! We include some tools to temporarily exclude the blog posts that you're not working on out of the way.

bundle exec rake isolate[filename-of-blogpost]

When you're done working on the site, run the following command to move the posts back again:

bundle exec rake integrate