mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-10 10:56:49 +00:00
Getting started, Advanced config: update (#33501)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
c0ffeeca7
GitHub
parent
8f68ac080e
commit
1a0e7aaa78
@ -5,7 +5,7 @@ description: "Details about the database used by Home Assistant."
|
||||
|
||||
Home Assistant uses databases to store {% term events %} and parameters for history and tracking. The default database used is [SQLite](https://www.sqlite.org/).
|
||||
|
||||
The database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder`](/integrations/recorder/) integration.
|
||||
The database file is stored in your [configuration directory](/docs/configuration/#to-find-the-configuration-directory) (e.g., `<path to config dir>/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder`](/integrations/recorder/) integration.
|
||||
|
||||
To work with SQLite database manually from the command-line, you will need an [installation](https://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](https://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands.
|
||||
First load your database with `sqlite3`:
|
||||
|
||||
@ -70,6 +70,12 @@ To set up file access, follow the steps for your [installation method](/installa
|
||||
- {% term "Home Assistant Core" %}: the `configuration.yaml` is in the config folder passed to the `hass` command (default is `~/.homeassistant`).
|
||||
3. Once you located the config folder, you can edit your `configuration.yaml` file.
|
||||
|
||||
{% note %}
|
||||
|
||||
If you have watched any videos about setting up Home Assistant using `configuration.yaml` (particularly ones that are old), you might notice your default configuration file is much smaller than what the videos show. Don't be concerned, you haven't done anything wrong. Many items in the default configuration files shown in those old videos are now included in the `default_config:` line that you see in your configuration file. Refer to the [default config integration](/integrations/default_config/) for more information on what's included in that line.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## Validating the configuration
|
||||
|
||||
After changing configuration or automation files, you can check if the configuration is valid. A configuration check is also applied automatically when you reload the configuration or when you restart Home Assistant.
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
%}
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /getting-started/configuration/ Advanced configuration %}
|
||||
{% active_link /getting-started/configuration/ Next steps %}
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@ -1,59 +1,48 @@
|
||||
---
|
||||
title: "Advanced Configuration"
|
||||
description: "Instructions to get Home Assistant configured."
|
||||
title: "Next steps"
|
||||
description: "Next steps in configuring your Home Assistant"
|
||||
related:
|
||||
- docs: configuration/basic/
|
||||
title: Changing basic settings
|
||||
- docs: /docs/configuration/
|
||||
title: configuration.yaml file
|
||||
- docs: /common-tasks/os/#network-storage
|
||||
title: Network storage
|
||||
- docs: /common-tasks/os/#backups
|
||||
title: Backups
|
||||
- docs: /voice_control/
|
||||
title: Voice control
|
||||
- url: https://companion.home-assistant.io/
|
||||
title: Home Assistant on Android and iOS
|
||||
---
|
||||
|
||||
The onboarding process takes care of the initial setup for Home Assistant, such as naming your home and selecting your location. After initial onboarding, these options can be changed in the user interface by clicking on Configuration in the sidebar and clicking on General, or by manually editing them in the Home Assistant configuration file called `configuration.yaml`. This section will explain how to do the latter.
|
||||
The onboarding process takes you through the initial setup for Home Assistant, such as getting the system up and running, naming your home and selecting your location. This section points you to further documentation helping you with the next steps.
|
||||
|
||||
{% note %}
|
||||
The steps below do not apply to Home Assistant Core & Container installations, for those types of installations, [see here](/docs/configuration/).
|
||||
{% endnote %}
|
||||
## Changing the basic settings
|
||||
|
||||
We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Home Assistant add-on store: the File editor. To get to the add-on store, go to {% my supervisor title="Settings > Add-ons" %}. On the new page, open the add-on store tab.
|
||||
To change basic settings such as location, unit system and language, refer to [Changing basic settings](/docs/configuration/basic/).
|
||||
|
||||
|
||||
## Creating a backup
|
||||
|
||||
Under the **Official add-ons** section, you will find the **File editor** add-on.
|
||||
You can back up your Home Assistant, add-on data, and configuration. Backups are used to restore a system or parts of it if a rollback is needed, or to migrate your Home Assistant to new hardware. It is good practice to create a backup before updating.
|
||||
|
||||
- Click on **File editor** and click on **Install**. When the installation is complete, the UI will go to the add-on details page for the file editor.
|
||||
- Now start the add-on by clicking on **Start**.
|
||||
- Open the user interface by clicking on **Open Web UI**.
|
||||
To learn how to create a backup of your Home Assistant installation, refer to the following topics:
|
||||
|
||||
Now let's make a change using the file editor: we are going to change the name, location, unit system, and time zone of your Home Assistant installation.
|
||||
- {% term "Home Assistant Operating System" %}: [Creating a backup from OS](/common-tasks/os/#backups)
|
||||
- {% term "Home Assistant Supervised" %}: [Creating a backup from Supervised](/common-tasks/supervised/#backups)
|
||||
|
||||
- Click the folder icon in the top left of the file editor window to open the file browser sidebar.
|
||||
- Click the `configuration.yaml` file (in the `/config/` folder) to load it into the main file editor window.
|
||||
- Add the following to this file (preferably at the very top, but it ultimately doesn't matter):
|
||||
```yaml
|
||||
homeassistant:
|
||||
name: Home
|
||||
latitude: xx.xxxx
|
||||
longitude: xx.xxxx
|
||||
unit_system: us_customary
|
||||
time_zone: America/Chicago
|
||||
```
|
||||
{% note %}
|
||||
## Editing the configuration.yaml and configuring file access
|
||||
|
||||
Valid options for `unit_system` are `us_customary` or `metric`. See [here](https://timezonedb.com/time-zones) for a list of valid time zones. Enter the appropriate option found under the Time Zone column at that page.
|
||||
While you can configure most of Home Assistant from the user interface, for some integrations, you will need to [edit the `configuration.yaml` file](/docs/configuration/). This file contains integrations to be loaded along with their configurations. Throughout the documentation, you will find snippets that you can add to your configuration file to enable specific functionality. For starters, there is no need to edit the `configuration.yaml` file. You will be pointed to the documentation when this is needed.
|
||||
|
||||
{% endnote %}
|
||||
## Setting up network storage
|
||||
|
||||
- Click the save icon in the top right to commit changes.
|
||||
- Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a configuration check. Do this by navigating to {% my server_controls title="Developer Tools > YAML" %} and then clicking on the **Check configuration** button. When it's valid, it will show the text "Configuration valid!". In order for the **Check Configuration**" button to be visible, you must enable **Advanced Mode** on your user profile.
|
||||
- Now restart Home Assistant. You can do so by either using the **Restart** option in the ⚙ menu of the File Editor UI or by navigating to {% my system_dashboard title="Settings > System" %} and then clicking on the **Restart** button on the top right of the page.
|
||||
If you need more space to store data, you can configure a [network storage](/common-tasks/os/#network-storage), for example to store backups or to access media.
|
||||
|
||||
|
||||
## Getting started with voice assistant
|
||||
|
||||
{% note %}
|
||||
If you want to get started with a voice assistant, refer to the documentation on [Assist](/voice_control/).
|
||||
|
||||
If you have watched any videos about setting up Home Assistant using `configuration.yaml` (particularly ones that are old), you might notice your default configuration file is much smaller than what the videos show. Don't be concerned, you haven't done anything wrong. Many items in the default configuration files shown in those old videos are now included in the `default_config:` line that you see in your configuration file. [See here](/integrations/default_config/) for more information on what's included in that line.
|
||||
## Apps for Android and iOS
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### Editing configuration via Samba/Windows Networking
|
||||
|
||||
Maybe you are not a big fan of our web editor and want to use a text editor on your computer instead. This is possible by sharing the configuration over the network using the Samba add-on, which can also be installed from the Home Assistant add-on store. This will make your configuration accessible via the network tab on your computer.
|
||||
|
||||
Go to the add-on store and look for Samba in the core section. After you have installed the add-on, click on **Start**. Home Assistant should now be available in the networking tab on your computer.
|
||||
|
||||
We suggest that to edit `configuration.yaml`, you use the free text editor [Visual Studio Code](https://code.visualstudio.com/) in combination with the [Home Assistant Configuration Helper extension](https://marketplace.visualstudio.com/items?itemName=keesschollaart.vscode-home-assistant).
|
||||
If you are looking for information on Home Assistant for Android or iOS, refer to the [documentation for the Companion Apps](https://companion.home-assistant.io/).
|
||||
|
||||
@ -15,4 +15,4 @@ show_title: true
|
||||
{% include getting-started/next_step.html step="Automation" link="/getting-started/automation/" icon="mdi:robot-happy" %}
|
||||
{% include getting-started/next_step.html step="Presence detection" link="/getting-started/presence-detection/" icon="mdi:motion-detector" %}
|
||||
{% include getting-started/next_step.html step="Join the community" link="/getting-started/join-the-community/" icon="mdi:people-group-outline" %}
|
||||
{% include getting-started/next_step.html step="Advanced Configuration" link="/getting-started/configuration/" icon="mdi:cog" %}
|
||||
{% include getting-started/next_step.html step="Next steps" link="/getting-started/configuration/" icon="mdi:cog" %}
|
||||
|
||||
@ -7,7 +7,7 @@ You made it here? Good job! You've been able to install Home Assistant and get a
|
||||
|
||||
Now that you've got that going, let's see what is next:
|
||||
|
||||
- Learn about [advanced configuration](/getting-started/configuration/) using `configuration.yaml` in our bonus step of the getting started guide.
|
||||
- Learn about [next steps](/getting-started/configuration/) of the getting started guide, such as creating a backup or configuring network storage.
|
||||
- Join the community in [our forums] or [our chat].
|
||||
- Check out [video tutorials] on a wide range of Home Assistant related topics
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user