diff --git a/docs/operating-system.md b/docs/operating-system.md new file mode 100644 index 00000000..a72766b2 --- /dev/null +++ b/docs/operating-system.md @@ -0,0 +1,6 @@ +--- +title: Home Assistant Operating System +sidebar_label: Introduction +--- + +This is the developer documentation for the Home Assistant Operating System. diff --git a/docs/hassio_debugging.md b/docs/operating-system/debugging.md similarity index 83% rename from docs/hassio_debugging.md rename to docs/operating-system/debugging.md index 4f85e100..562855f8 100644 --- a/docs/hassio_debugging.md +++ b/docs/operating-system/debugging.md @@ -1,5 +1,6 @@ --- -title: "Debugging Home Assistant" +title: "Debugging the Home Assistant Operating System" +sidebar_label: Debugging --- :::info @@ -8,33 +9,6 @@ This section is not for end users. End users should use the [SSH add-on] to SSH [SSH add-on]: https://github.com/home-assistant/hassio-addons/tree/master/ssh -The following debug tips and tricks are for developers who are running the Home Assistant image and are working on the base image. If you use the generic Linux installer script, you should be able to access your host and logs as per your host. - -## Debug Supervisor - -Visual Studio Code config: - -```json -{ - "version": "0.2.0", - "configurations": [ - { - "name": "Supervisor remote debug", - "type": "python", - "request": "attach", - "port": 33333, - "host": "IP", - "pathMappings": [ - { - "localRoot": "${workspaceFolder}", - "remoteRoot": "/usr/src/hassio" - } - ] - } - ] -} -``` - You need set the dev mode on supervisor and enable debug with options. You need also install the Remote debug Add-on from Developer Repository to expose the debug port to Host. ## SSH access to the host diff --git a/docs/architecture_hassio.md b/docs/supervisor.md similarity index 64% rename from docs/architecture_hassio.md rename to docs/supervisor.md index 3debeaa0..eeec4c08 100644 --- a/docs/architecture_hassio.md +++ b/docs/supervisor.md @@ -1,6 +1,6 @@ --- -title: "Hass.io Architecture" -sidebar_label: Hass.io +title: Home Assistant Supervisor +sidebar_label: Introduction --- Home Assistant integration development" -sidebar_label: "Integration development" +title: "Home Assistant Supervisor <> Core/Frontend development" +sidebar_label: "Developing" --- -These steps will help you connect your local Home Assistant to a remote Hass.io instance. You can then make changes locally to either the Hass.io component or the frontend and test it out against a real instance. +These steps will help you connect your local Home Assistant to a remote Supervisor instance. You can then make changes locally to either the Hass.io integration or the frontend and test it out against a real instance. -For this guide, we're going to assume that you have an Hass.io instance up and running. If you don't, you can use the generic installation method to install it inside a [virtual machine](https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio). +For this guide, we're going to assume that you have an Home Assistant instance up and running. If you don't, you can use the generic installation method to install it inside a [virtual machine](https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio). ## API Access @@ -20,11 +20,11 @@ For some API commands you need explicit the Home Assistant API token, but 99% of docker inspect homeassistant | grep HASSIO_TOKEN ``` -## Having Home Assistant connect to remote Hass.io +## Having Home Assistant connect to remote Supervisor The connection with the supervisor is hidden inside the host and is only accessible from applications running on the host. So to make it accessible for our Home Assistant instance we will need to route the connection to our computer running Home Assistant. We're going to do this by forwarding the API with "Remote API proxy" add-on. -First, make sure Home Assistant will load the Hass.io component by adding `hassio:` to your `configuration.yaml` file. Next, we will need to tell the local Home Assistant instance how to connect to the remote Hass.io instance. We do this by setting the `HASSIO` and `HASSIO_TOKEN` environment variables when starting Home Assistant. Note that the `HASSIO` value is not the same as the one that we saw above and the `HASSIO_TOKEN` is available inside log output of "Remote API Add-on" (This changes every restart of the add-on!). +First, make sure Home Assistant will load the Hass.io integration by adding `hassio:` to your `configuration.yaml` file. Next, we will need to tell the local Home Assistant instance how to connect to the remote Supervisor instance. We do this by setting the `HASSIO` and `HASSIO_TOKEN` environment variables when starting Home Assistant. Note that the `HASSIO` value is not the same as the one that we saw above and the `HASSIO_TOKEN` is available inside log output of "Remote API Add-on" (This changes every restart of the add-on!). ```shell HASSIO=:80 HASSIO_TOKEN= hass @@ -45,10 +45,10 @@ Update the Hass.io component configuration in your `configuration.yaml` to point ```yaml # configuration.yaml hassio: - development_repo: /home/paulus/dev/hass/home-assistant-polymer + development_repo: /home/paulus/dev/hass/frontend ``` -To build a local version of the Hass.io panel, go to the frontend repository and run: +To build a local version of the Supervisor panel, go to the frontend repository and run: ```shell cd hassio @@ -57,4 +57,4 @@ script/develop Now start Home Assistant as discussed in the previous section and it will now connect to the remote Hass.io but show your local frontend. -Once you have `script/develop` the hassio panel will be rebuilt whenever you make changes to the source files. +Once you have `script/develop` the Supervisor panel will be rebuilt whenever you make changes to the source files. diff --git a/docusaurus.config.js b/docusaurus.config.js index 28e341f0..deedcbe7 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -30,7 +30,9 @@ module.exports = { to: "docs/development_index", }, { to: "docs/frontend", label: "Frontend" }, + { to: "docs/supervisor", label: "Supervisor" }, { to: "docs/add-ons", label: "Add-ons" }, + { to: "docs/operating-system", label: "Operating System" }, { to: "docs/internationalization", label: "Internationalization" }, ], }, diff --git a/sidebars.js b/sidebars.js index 03fb5805..e2cc5ec1 100644 --- a/sidebars.js +++ b/sidebars.js @@ -69,12 +69,14 @@ module.exports = { "internationalization/custom_integration", "translations", ], + OperatingSystem: ["operating-system", "operating-system/debugging"], + Supervisor: ["supervisor", "supervisor/developing", "supervisor/debugging"], + // Old structure, still to move/migrate Architecture: { Architecture: [ "architecture_index", "architecture_components", "architecture_entities", - "architecture_hassio", ], Entities: [ "entity_index", @@ -170,7 +172,6 @@ module.exports = { "asyncio_categorizing_functions", "asyncio_working_with_async", ], - "Hass.io": ["hassio_debugging", "hassio_hass"], "Maintainer docs": ["maintenance"], }, }; diff --git a/static/_redirects b/static/_redirects index 733d63d3..2480ecbb 100644 --- a/static/_redirects +++ b/static/_redirects @@ -32,8 +32,11 @@ /docs/hassio_addon_security /docs/add-ons/security /docs/hassio_addon_testing /docs/add-ons/testing /docs/hassio_addon_tutorial /docs/add-ons/tutorial +/docs/hassio_debugging /docs/supervisor/debugging +/docs/hassio_hass /docs/supervisor/developing /docs/internationalization_backend_localization /docs/internationalization/core /docs/internationalization_custom_component_localization /docs/internationalization/custom_integration /docs/internationalization_index /docs/internationalization /docs/internationalization_translation /docs/translations -/docs/lovelace_custom_card /docs/frontend/custom-ui/lovelace-custom-card \ No newline at end of file +/docs/lovelace_custom_card /docs/frontend/custom-ui/lovelace-custom-card +/docs/architecture_hassio /docs/supervisor