🕷️ Crawler Inspector

URL Lookup

Direct Parameter Lookup

Raw Queries and Responses

1. Shard Calculation

Query:

Response:

Calculated Shard: 77 (from laksa142)

2. Crawled Status Check

Query:

curl -X POST \
  'http://laksa077.int.ahrefs:8124/' \
  -H 'Content-Type: text/plain' \
  -H 'X-ClickHouse-Database: crawler3' \
  -H 'Authorization: Basic YXBpOg==' \
  -d 'SELECT getAhrefsURLFromUnparsed(src_unparsed) AS found_url, ifNull(toUnixTimestamp(download_stamp), 0) AS crawl_time, ifNull(toUnixTimestamp(props_url_first_seen), 0) AS first_indexed_time, download_http_code AS http_code, src_unparsed AS src_unparsed, src_root_hash AS src_root_hash, history_drop_reason AS history_drop_reason, meta_title AS meta_title, meta_descriptions AS meta_descriptions, attrs_boilerpipe_text AS attrs_boilerpipe_text, attrs_markdown AS attrs_markdown, attrs_readable_markdown AS attrs_readable_markdown, meta_canonical AS meta_canonical FROM crawler3.page_info_local FINAL PREWHERE (src_root_hash, src_unparsed) IN ((getAhrefsRootHashFromUnparsed(getAhrefsUnparsedNoserviceFromURL(\'https://www.home-assistant.io/common-tasks/os/\')), getAhrefsUnparsedNoserviceFromURL(\'https://www.home-assistant.io/common-tasks/os/\'))) FORMAT JSONEachRow'

Response:

{"found_url":"https:\/\/www.home-assistant.io\/common-tasks\/os\/","crawl_time":1775671346,"first_indexed_time":1613076658,"http_code":200,"src_unparsed":"io,home-assistant!www,\/common-tasks\/os\/ s443","src_root_hash":"6959518072785130877","history_drop_reason":null,"meta_title":"Common tasks - Operating System - Home Assistant","meta_descriptions":["Common tasks for Home Assistant Operating System"],"attrs_boilerpipe_text":"This section will provide guides to some common tasks and information which you will need in order to run, maintain, and edit your Home Assistant OS system. For further details on any particular subject, make sure to refer to the documentation for specific apps (formerly known as add-ons) or topics listed here.\nConfiguring access to files\nYour Home Assistant Operating server includes two repositories by default: The official core app repository, and the community app repository. All of the apps mentioned here can be installed by navigating to the app store using\nSettings\n>\nApps\n>\nInstall app\nin the UI.\nOne of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several apps commonly used for this, and most users employ a mix of various apps. Default directories on the host are mapped to the apps so that they can be accessed by the services any particular app might provide. On the host system these directories exist on the\n\/data\npartition at\n\/mnt\/data\/supervisor\/\n.\nUsing any of the apps listed below, the following directories are made available for access:\naddons\nbackup\nconfig\nmedia\nshare\nssl\nInstalling and using the Samba app\nThe\nSamba\napp allows you to share the directories on Home Assistant with other systems on your network. After installing the app, you can then also edit files using the editor of your preference from your client computer. This app can be installed from the app store’s official repository.\nTo install the app, follow these steps:\nGo to\nSettings\n>\nApps\n>\nSamba share\nand select\nInstall\n.\nOn the\nConfiguration\ntab, define\nUsername\nand\nPassword\n, store them in a safe place, and save your changes.\nYou can specify any username and password.\nThey are not related to the login credentials you use to log in to Home Assistant or to log in to the computer from which you are accessing the files.\nThe app won’t start if username and password are not defined.\nFor further configuration information, refer to the\nDocumentation\ntab.\nTo start the app, on the\nInformation\ntab, select\nStart\n.\nTo access the Home Assistant directories from the other device, follow these steps:\nGo to\nSettings\n>\nSystem\n>\nNetwork\nand take note of the\nHost name\n.\nAlternatively, you can look up the host name or IP address of your Home Assistant on your router.\nHow you connect from another device to Home Assistant depends on your system. Use one of the following options:\nOn Windows\n: Open\nFile Explorer\nand in the address bar, enter the IP address or hostname with two backslashes as\n\\\\your.ha.ip.address\nor\n\\\\hostname\n.\nScreenshot of File Explorer displaying the navigation to a file share using an IP address\nOn OS X\n: Open\nFinder\nand select\nGo\n>\nConnect to Server…\nand enter the IP address or hostname as\nsmb:\/\/your.ha.ip.address\nor\nsmb:\/\/hostname\n.\nOn Ubuntu\n: Open\nFiles\nand in the address bar, enter the IP address or hostname as\nsmb:\/\/your.ha.ip.address\nor\nsmb:\/\/hostname\n.\nEnter the credentials you entered in the\nSamba\napp configuration.\nYou also have the option of having the credentials stored so that you do not need to enter them again.\nDone! You now have access to the directories which you can then mount as a drive or pin to Quick Access.\nInstalling and using the Visual Studio Code (VSC) app\nThe\nStudio Code Server\napp provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64\/ARM64 machines. The app also provides access to the Home Assistant Command Line Interface (CLI) using VSC’s built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and apps, creating\/restoring backups, and more. (See\nHome Assistant via Command Line\nfor further info).\nExample of a configuration.yaml file, accessed using the Studio Code Server app on a Home Assistant Operating System installation.\nTo install and use the\nStudio Code Server\nin Home Assistant, follow these steps:\nTo install the app, go to\nSettings\n>\nApps\n>\nStudio Code Server\nand install the app.\nOnce you have the app installed, if you want, select the\nShow in sidebar\noption. Then, select\nStart\n.\nFor information on configuration settings, open the\nDocumentation\ntab.\nTo start browsing, on the\nInfo\ntab, select\nOpen Web UI\n.\nInstalling and using the File Editor app\nThe\nFile Editor\napp is a web-based file system browser and text editor. It is a more basic and light weight alternative to Visual Studio Code. YAML files are automatically checked for syntax errors while editing.\nExample of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.\nTo install and use the File Editor in Home Assistant, follow these steps:\nTo install the app, go to\nSettings\n>\nApps\n>\nFile editor\n.\nOnce you have the app installed, you can edit files within your\n\/config\ndirectory.\nIf you want to be able to access directories outside the\n\/config\ndirectory, you need to disable an option in the app configuration.\nGo to the app under\nSettings\n>\nApps\n>\nFile editor\n.\nOpen the\nConfiguration\ntab.\nIn the configuration settings, disable the\nEnforce basepath\noption.\nNote: The\nEnforce basepath\noption is intended to protect you from inadvertently making changes to settings files.\nFor information on other configuration settings, open the\nDocumentation\ntab.\nTo confirm your changes, select\nSave\n.\nTo start browsing, on the\nInfo\ntab, select\nOpen Web UI\n.\nInstalling and using the SSH app\nIf you want to use the Home Assistant command line or an SSH client, you can do this through the\nTerminal & SSH\napp.\nThe\nTerminal & SSH\napp provides the following functionalities:\nIt provides a web terminal that you can access from the Home Assistant user interface.\nIt allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and apps, creating\/restoring backups, and more.\nFor a list of command line commands, refer to\nHome Assistant via Command Line\n.\nIt allows connecting to your system using an SSH client.\nIt also includes common tools like nano and vi editors.\nThe Terminal & SSH app does\nnot provide\naccess to the underlying host file system.\nTo get started with the\nTerminal & SSH\napp, follow these steps:\nIn the bottom left, select your user to open the\nProfile\npage. Make sure\nAdvanced Mode\nis enabled.\nTo install the app, go to the app store under\nSettings\n>\nApps\nand install the\nTerminal & SSH\napp.\nTo use the web terminal,\nstart\nthe app, then select\nOpen Web UI\n.\nYou can now start typing your\ncommands\n.\nIf you want to access from an ssh client, you need to enter credentials:\nOpen the\nConfiguration\npage.\nEnter a password or authorized Keys.\nThen save and start the app.\nBackup\nTo learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under\ncommon tasks\n.\nAlternative: Creating a backup using the Home Assistant Command Line Interface\nIn general, to create or restore from a backup, follow the steps described under\ncommon tasks\n. However, If you have the\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\ninstalled, you can also create a backup from the command line. Follow these steps:\nha backups list\n- lists backups and their slugnames\nha backups restore slugname\n- restores a specific backup\nha backups new --name nameofbackup\n- create a backup\nFor additional information about command line usage, use the\nha help\ncommand or refer to the\nHome Assistant Command Line documentation\n.\nUpdating Home Assistant\nIf you have the\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\ninstalled, you receive update notifications from different components:\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\nHome Assistant Supervisor\nThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System.\nHome Assistant Core\nHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated.\nApps\nApps are additional standalone third-party software packages that can be installed on Home Assistant OS.\n[Learn more]\n, if you have any installed\nEach of these components needs to be updated separately.\nUpdating the Home Assistant Operating System\nUpdates of the\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\nare independent of other updates. They do not trigger repair issues and are usually backward-compatible.\nPrerequisites\nBackup your installation\n.\nMake sure the backup is stored on a\nbackup location\noutside of the device where Home Assistant is installed.\nFor example, if Home Assistant is installed on\nHome Assistant Green\n, make sure it is stored on\nHome Assistant Cloud\nor another location.\nSo that you can\nrestore from that backup\nin case there is an issue with the system.\nTo update the Home Assistant Operating System\nUsing the UI\nUsing the CLI\nOpen the\nSettings\npanel.\nOn the top you will be presented with an update notification.\nTroubleshooting: If you do not see that notification:\nIn the top right corner, select the three dots\nmenu and select\nCheck for updates\n.\nGo to\nSystem\n>\nUpdates\n.\nSelect the update notification.\nSelect the cogwheel\n, then set\nVisible\nto active.\nOpen the notification for the component you want to update.\nIf you want to update the system first (recommended), enable the backup toggle.\nSelect\nUpdate\n.\nCheck if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed.\nha os update\nThis updates to the latest version. If you want to update to a specific version instead, use\nha os update --version 15.2\n.\nAdvanced: changing the boot slot used during the update\nAbout boot slots used during the update\nThe\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\nuses two boot slots. On first installation, boot slot A is used. After that, on each Operating System update, the other boot slot is updated and reboot is triggered. On that reboot, the system boots from the other boot slot (A ➝ B ➝ A,…). When booting fails, the system automatically uses the previous boot slot, so that it boots from the last working operating system.\nChanging the boot slot used\nYou can manually define that the previous boot slot is used. This can be useful in cases where the system boots but something still seems wrong. For example, when the device is no longer correctly detected or you see another issue that might be related to the latest update of the operating system.\nTo check which boot slot is currently in use and what OS versions are installed in the individual slots, in the Home Assistant command line, enter the following command:\nha os info\nTo change the boot slot, enter the following command:\nThis will boot into the other (previous) OS version.\nha os boot-slot other\nAlternatively, if the Operating Systems runs on a platform that uses the GRUB bootloader, a boot menu is presented early in the boot. The alternative boot slot can be selected here, marking it active for future boots if the following boot attempt is successful.\nUpdating Home Assistant Core\nPrerequisites\nBack up your installation\nand store the backup and the\nbackup emergency kit\nsomewhere safe.\nThis ensures that you can\nrestore your installation from backup\nif needed.\nCheck the release notes for backward-incompatible changes on\nHome Assistant release notes\n. Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (\nCTRL + f\n\/\nCMD + f\n) and search for\nBackward-incompatible changes\n.\nTo update Home Assistant Core\nTo update Home Assistant Core, choose one of the following options.\nUsing the UI\nUsing the CLI\nOpen your Home Assistant UI.\nGo to the\nSettings\npanel.\nOn the top you will be presented with an update notification.\nTroubleshooting: If you do not see that notification:\nIn the top right corner, select the three dots\nmenu and select\nCheck for updates\n.\nGo to\nSystem\n>\nUpdates\n.\nSelect the update notification.\nSelect the cogwheel\n, then set\nVisible\nto active.\nOpen the notification for the component you want to update.\nIf you want to backup the system first (recommended), enable the backup toggle.\nSelect\nUpdate\n.\nAfter the update completed, check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed.\nha core update\n--backup\nThe\n--backup\nflag here ensures that you have a partial backup of your current setup in case you need to downgrade.\nNetwork storage\nYou can configure both Network File System (NFS) and Samba\/Windows (CIFS) targets to be used within Home Assistant and apps.\nTo list all your currently connected network storages, go to\nSettings > System > Storage\nin the UI.\nImportant\nYou need to update to Home Assistant Operating System 10.2 before you can use this feature.\nScreenshot of the list of network shares inside the storage panel.\nAdd a new network storage\nGo to\nSettings > System > Storage\nin the UI.\nSelect\nAdd network storage\n.\nFill out all the information for your network storage.\nSelect\nConnect\n.\nScreenshot of connecting a new network storage.\nNetwork storage configuration\nName\nThis is the name that will be used for the mounted directory on your system.\nUsage\nHere, you select how the target should be used.\nSee usage types below\nServer\nThe IP\/hostname of the server running NFS\/CIFS.\nProtocol\n3\nThe service the server is using for the network storage.\n[NFS]\n1\nRemote share path\nThe path used to connect to the remote storage server.\n[CIFS]\n2\nUsername\nThe username to use when connecting to the storage server. Use User Principal Name for domain accounts. For example:\n[email protected]\n.\n[CIFS]\n2\nPassword\nThe password to use when connecting to the storage server.\n[CIFS]\n2\nShare\nThe share to connect to on the storage server.\n1\nOptions prefixed with\n[NFS]\nare only available for NFS targets.\n2\nOptions prefixed with\n[CIFS]\nare only available for CIFS targets.\n3\nFor the\nCIFS\noption, only version 2.1+ is supported.\nUsage types\nBackup\nThis will become a target. You can use it when creating an automatic or manual backup. The first storage you add of this type becomes your new default target. If you want to change the default target,\ncheck out the documentation below\n.\nMedia\nA new directory with the name you gave your network storage will be created under\n\/media\n. This directory can be accessed by Home Assistant and apps.\nShare\nA new directory with the name you gave your network storage will be created under\n\/share\n.  This directory can be accessed by Home Assistant and apps.\nChange default local backup location\nBy default, the first network storage of type\nBackup\nthat you add is used as your local default backup location.\nIf you want to change the local network storage that is used to store your backups, follow these steps:\nGo to\nSettings > System > Backups\n.\nSelect\nSettings and history\n.\nIn the top-right corner, select the three dots\nmenu and select\nChange default action location\n.\nSelect your preferred network location and save your changes.\nTroubleshooting: Don’t see your external storage location? This list contains only the network storage targets you have added of type\nBackup\n.\nLost Password and password reset\nPlease refer to the\nI’m locked out!\ndocumentation page.\nInstalling a third-party app repository\nHome Assistant allows anyone to create an app repository to share their own apps with the community.\nWarning\nHome Assistant cannot guarantee the quality or security of third-party apps. Use at your own risk.\nTo add an app repository, follow these steps:\nCopy the URL of the repository.\nThe URL is the git repository clone URL (on GitHub, use the Code button and copy the HTTPS URL).\nThis documentation uses an example app repository. It is not practically useful but follows the same steps.\nIf you are interested in app development, refer to our\nHome Assistant app development documentation\n.\nhttps:\/\/github.com\/home-assistant\/hassio-addons-example\nGo to\nSettings\n>\nApps\nand select\nApp store\n.\nIn the top-right corner, select the three dots\nmenu, and select\nRepositories\n.\nAdd the URL of the repository and select\nAdd\n.\nResult: A new card for the third-party repository will appear.\nTroubleshooting: Repository is not showing up\nIf you have added an app repository, but it’s not showing up, make sure to refresh your browser. If it still doesn’t show up, the app repository may contain invalid configuration data.\nGo to\nSettings\n>\nSystem\n>\nLogs\nand select Supervisor in the top right corner to get the Supervisor log.\nIt should tell you what went wrong.\nReport this information to the app repository author.\nConfiguration check\nAfter changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core.\nRunning a configuration check from the UI\nGo to\nyour user profile\nand enable\nAdvanced Mode\n.\nGo to\nSettings\n>\nDeveloper tools\n>\nYAML\nand in the\nConfiguration validation\nsection, select the\nCheck configuration\nbutton.\nThis is to make sure there are no syntax errors before restarting Home Assistant.\nIt checks for valid\nYAML\nYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the\nconfiguration.yaml\nor\nautomations.yaml\nfiles.\n[Learn more]\nand valid config structures.\nIf you need to do a more comprehensive configuration check,\nrun the check from the CLI\n.\nRunning a configuration check from the CLI\nUse the following command to check if the configuration is valid. The command line configuration check validates the\nYAML\nYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the\nconfiguration.yaml\nor\nautomations.yaml\nfiles.\n[Learn more]\nfiles and checks for valid config structures, as well as some other elements.\nha core check\nHome Assistant versions\nTo see which version your system is running, go to\nSettings\n>\nAbout\n.\nFeature preview\nIf you want to preview upcoming features, you can enable preview under\nSettings\n>\nSystem\n>\nLabs\n.\nLabs\nallows you to preview selected features that are stable but are still being fine-tuned. Preview is different from installing a beta or development version, which are used for development and testing.\nFor more information, refer to the\nLabs documentation\n.\nRunning a beta version\nIf you would like to test next release before anyone else, you can install the beta version.\nFrom the UI\nFrom the CLI\nIn Home Assistant, go to\nSystem\n>\nUpdates\n.\nIn the top-right corner, select the three dots\nmenu.\nSelect\nJoin beta\n.\nGo to the\nConfiguration\npanel.\nInstall the update that is presented to you.\nTroubleshooting: If you do not see that notification:\nIn the top right corner, select the three dots\nmenu and select\nCheck for updates\n.\nGo to\nSystem\n>\nUpdates\n.\nSelect the update notification.\nSelect the cogwheel\n, then set\nVisible\nto active.\nJoin the beta channel.\nha supervisor options\n--channel\nbeta\nReload Home Assistant Supervisor.\nha supervisor reload\nUpdate Home Assistant Core to the latest beta version.\nha core update\n--backup\nThe\n--backup\nflag here ensures that you have a partial backup of your current setup in case you need to downgrade.\nRunning a development version\nIf you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to\ndev\n.\nCaution\nThe\ndev\nbranch is likely to be unstable. Potential consequences include loss of data and instance corruption.\nJoin the dev channel.\nha supervisor options\n--channel\ndev\nReload the\nHome Assistant Supervisor\nThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System.\n.\nha supervisor reload\nUpdate\nHome Assistant Core\nHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated.\nto the latest dev version.\nha core update\n--backup\nThe\n--backup\nflag here ensures that you have a partial backup of your current setup incase you need to downgrade.\nRunning a specific version\nTo upgrade to a specific version, you can use the command line (CLI). The example below shows how to upgrade to\n2026.4.1\n. To learn how to get started with the command line in Home Assistant, refer to the\nSSH app setup instructions\n.\nha core update\n--version\n2026.4.1\n--backup\nThe\n--backup\nflag here ensures that you have a partial backup of your current setup in case you need to downgrade later.\nTo downgrade your installation, do a\npartial restore of a backup\ninstead.\nUsing external data disk\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\nsupports storing data on a secondary storage medium. For example, this can be a second internal SSD or HDD or a USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster.\nThe data disk feature can be used on an existing installation without losing data: The system will move existing data to the external data disk automatically. However, it is recommended to create and download a full\nBackup\nbefore proceeding!\nCaution\nAll data on the target disk will be overwritten!\nImportant\nThe storage capacity of the external data disk must be larger than the storage capacity of the existing (boot) disk.\nImportant\nIf you have been using a data disk previously with\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\n, you need to use your host computer to delete all partitions\nbefore\nusing it as a data disk again.\nUsing UI to move the data partition\nConnect the data disk to your system.\nGo to\nSettings > System > Storage\nin the UI.\nSelect\nMove data disk\n.\nSelect the data disk from the list of available devices.\nSelect\nMove\n.\nDepending on the amount of data, this may take a while.\nUsing CLI to move the data partition\nTo see the current data disk use:\n$\nha os info\n...\ndata_disk: \/dev\/mmcblk1p4\n...\nTo get a list of potential targets which can be used by\ndatadisk\n:\nha os datadisk list\nTo initiate the move to the new data disk use the\nmove\ncommand:\nha os datadisk move \/dev\/sdx\nThe system will prepare the data disk and immediately reboot. The reboot will take 10 minutes or more depending on the speed of the new data disk; please be patient!\nWarning\nUsing an USB attached SSD can draw quite some power. For instance on Raspberry Pi 3 the official Raspberry Pi power supply (PSU) only provides 2.5A which can be too tight. Use a more powerful power supply if you experience issues. Alternatively use a powered USB hub. Connect the Hub to one of the USB slots of your Raspberry Pi, and connect the SSD to the Hub. In this setup the power supply of the Hub will power the attached device(s).\nMigrating an external data disk to another system\nThis section shows how to move an external data disk from one system to another.\nThis can be an option if the following elements apply to your use case:\nYou already have a functioning Home Assistant instance (system 1) that is using an external data disk.\nYou have another, new, Home Assistant instance (system 2).\nYou now want to use the data disk of system 1 on system 2 instead.\nThe aim is to migrate the data from system 1 to system 2. One way to do this is by\nrestoring a backup\n. The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk or if your external disk has more storage capacity than your new system.\nPrerequisites\nA Home Assistant instance using an external data disk (system 1)\nA Home Assistant instance to which you want to move the external data disk (system 2)\nTo migrate an external data disk to another system\nTo migrate an external data disk from one system to another, follow these steps:\nCreate a backup\nof both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data).\nShut down system 1 and remove the data disk.\nMake sure system 2 has Home Assistant OS installed, and Home Assistant is up and running. Home Assistant is using the data disk (partition) on the boot drive (e.g. SD card) at this point.\nMake sure system 2 has completed the basic\nonboarding\nsteps, including the last steps where devices are discovered automatically.\nPlug the external disk into system 2 and go to the\nSettings\n>\nSystem\n. Select the three dots\nmenu, and\nRestart Home Assistant\n>\nReboot system\n.\nResult: A repair issue is displayed\nMultiple data disks detected\n.\nThe repair issue comes up because system 2 now sees two file systems with an identical name. During a reboot, there is a name conflict with the existing data disk as it is undefined which file system should be used. This can lead to a random selection of the system you end up with. Hence you must make a decision.\nOpen the repair issue and choose one of the options:\nSelect\nUse the detected data disk instead of the current system\n.\nThis will override the current file system of system 2 and use your external data disk instead.\nYou won’t have access anymore to the current Home Assistant data. It will be marked as inactive data disk.\nIf you changed your mind about using the external data disk:\nUnplug the external data disk.\nIf you cannot unplug the external data disk for some reason, select\nMark as inactive data disk (rename file system)\n.\nThis makes sure that there is no name conflict after rebooting.\nIt also means you cannot use the file system that is stored on your external disk.\nYou keep using the current file system of system 1.\nHome Assistant via the command line\nOn the\nSSH command line\n, you can use the\nha\ncommand to retrieve logs, check the details of connected hardware, and more.\nHome Assistant\nha core check\nha core info\nha core logs\nha core options\nha core rebuild\nha core restart\nha core restart\n--safe-mode\nha core start\nha core stats\nha core stop\nha core update\nSupervisor\nha supervisor info\nha supervisor logs\nha supervisor reload\nha supervisor update\nHost\nha host reboot\nha host shutdown\nha host update\nHardware\nha hardware info\nha hardware audio\nUsage examples\nTo update Home Assistant to a specific version, use the command:\nha core update\n--version\nx.y.z\nReplace x.y.z with the desired version like\n--version 2026.4.1\nYou can get a better description of the CLI capabilities by typing\nha help\n:\nThe Home Assistant CLI is a small and simple command line utility that allows\nyou to control and configure different aspects of Home Assistant\n\nUsage:\n  ha [command]\n\nAvailable Commands:\n  addons         Install, update, remove and configure Home Assistant apps\n  audio          Audio device handling.\n  authentication Authentication for Home Assistant users.\n  backups        Create, restore and remove backups\n  banner         Prints the CLI Home Assistant banner along with some useful information\n  cli            Get information, update or configure the Home Assistant cli backend\n  core           Provides control of the Home Assistant Core\n  dns            Get information, update or configure the Home Assistant DNS server\n  docker         Docker backend specific for info and OCI configuration\n  hardware       Provides hardware information about your system\n  help           Help about any command\n  host           Control the host\/system that Home Assistant is running on\n  info           Provides a general Home Assistant information overview\n  jobs           Get information and manage running jobs\n  multicast      Get information, update or configure the Home Assistant Multicast\n  network        Network specific for updating, info and configuration imports\n  observer       Get information, update or configure the Home Assistant observer\n  os             Operating System specific for updating, info and configuration imports\n  resolution     Resolution center of Supervisor, show issues and suggest solutions\n  supervisor     Monitor, control and configure the Home Assistant Supervisor\n\nFlags:\n      --api-token string   Home Assistant Supervisor API token\n      --config string      Optional config file (default is $HOME\/.homeassistant.yaml)\n      --endpoint string    Endpoint for Home Assistant Supervisor (default is 'supervisor')\n  -h, --help               help for ha\n      --log-level string   Log level (defaults to Warn)\n      --no-progress        Disable the progress spinner\n      --raw-json           Output raw JSON from the API\n\nUse \"ha [command] --help\" for more information about a command.\nConsole access\nYou can also access the\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\nvia a directly connected keyboard and monitor, the console.\nWiping the data disk from the command line\nIn\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\n, the\nha os datadisk wipe\ncommand wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed apps.\nThe command\nha os datadisk wipe\nmarks the data partition (either internal on the eMMC or the SD card, or on an external attached data disk) as to be cleared on the next reboot. The command automatically reboots the system. Upon reboot, the data is cleared. Then the system continues to boot and reinstalls the latest version of all Home Assistant components.\nThe\nha os datadisk wipe\ncommand can only be run from the local terminal. Connect a display and keyboard and use the terminal.\nNote, some systems have a reset button you can use to clear the data disk, instead of using the command line:\nIf you have a Home Assistant Yellow with a Raspberry Pi Compute Module 5, use the command line steps described above.\nIf you have a Home Assistant Yellow with a Raspberry Pi Compute Module 4, there is a red hardware button to wipe the data disk. Follow the procedure on\nresetting the Home Assistant Yellow\n.\nIf you have a Home Assistant Green, there is a black hardware button to wipe the data disk. Follow the procedure on\nresetting the Home Assistant Green\n.\nListing all users from the command line\nIn\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\n, the\nha auth list\ncommand lists all users that are registered on your Home Assistant.\nThe\nha auth list\ncommand can only be run from the local terminal. Connect a display and keyboard and use the terminal.\nEnable duplicate log file\nBy default, Home Assistant Core logs are sent to the Systemd Journal, which can be read using the\nha core logs\ncommand\n. If you need logs to also be written to a file (\n\/config\/home-assistant.log\n), you can enable the duplicated log file option using the\ncommand line\n:\nha core options\n--duplicate-log-file\n=\ntrue\nha core rebuild\nha core restart\nTo disable it:\nha core options\n--duplicate-log-file\n=\nfalse\nha core rebuild\nha core restart\nEnable I2C\nHome Assistant using the\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\nwhich is a managed environment, which means you can’t use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to\nEnable I2C for the Home Assistant Operating System\nSetup I2C devices e.g. sensors\nEnable I2C with an SD card reader\nAccess the boot partition\nYou will need:\nSD card reader\nSD card with\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\nflashed on it\nShutdown\/turn-off your Home Assistant installation and unplug the SD card.\nPlug the SD card into an SD card reader and find a drive\/file system named\nhassos-boot\n. The file system might be shown\/mounted automatically. If not,\nuse your operating systems disk management utility to find the SD card reader\nand make sure the first partition is available.\nAdd files to enable I2C\nIn the root of the\nhassos-boot\npartition, add a new folder called\nCONFIG\n.\nIn the\nCONFIG\nfolder, add another new folder called\nmodules\n.\nInside the\nmodules\nfolder add a text file called\nrpi-i2c.conf\nwith the following content:\ni2c-dev\nIn the root of the\nhassos-boot\npartition, edit the file called\nconfig.txt\nadd two lines\nto it:\ndtparam=i2c_vc=on\ndtparam=i2c_arm=on\nStart with the new OS configuration\nInsert the SD card back into your Raspberry Pi.\nOn startup, the\nhassos-config.service\nwill automatically pickup the new\nrpi-i2c.conf\nconfiguration.\nAnother reboot might be necessary to make sure the just imported\nrpi-i2c.conf\nis\npresent at boot time.\nEnable I2C via Home Assistant Operating System Terminal\nAlternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the\nHome Assistant Operating System\nHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\n.\nYou can enable I2C via this terminal:\nLogin as\nroot\n.\nType\nlogin\nand press enter to access the shell:\nmkdir\n-p\n\/mnt\/boot\/CONFIG\/modules\necho\ni2c-dev\n>\n\/mnt\/boot\/CONFIG\/modules\/rpi-i2c.conf\necho\ndtparam\n=\ni2c_vc\n=\non\n>>\n\/mnt\/boot\/config.txt\necho\ndtparam\n=\ni2c_arm\n=\non\n>>\n\/mnt\/boot\/config.txt\nsync\nreboot\nTroubleshooting\nAfter rebooting the host there should be\ni2c-0\nand similar device files in\n\/dev\n. If such device files are missing, enabling I2C failed for some reason. You can check the status of I2C kernel modules by using\nlsmod | grep i2c\nin the terminal. If they are loaded, you should find at least the entry\ni2c_dev\n. Active usage of the modules is indicated by a number, e.g.\ni2c_dev 20480 2\nwould indicate two active I2C device files.\nAn active I2C can also be checked with a multi meter showing 3.3 V on the I2C pins GPIO2 and GPIO3.\nHelp us improve our documentation\nSuggest an edit to this page, or provide\/view feedback for this page.\nEdit\nProvide feedback\nView given feedback","attrs_markdown":"[2026\\.4.1](https:\/\/www.home-assistant.io\/blog\/2026\/04\/01\/release-20264\/ \"Latest version 2026.4.1 released April  3, 2026\")\n\n- [Getting started](https:\/\/www.home-assistant.io\/installation\/)\n- [Documentation](https:\/\/www.home-assistant.io\/docs\/)\n  - [Installation](https:\/\/www.home-assistant.io\/installation\/)\n  - [Automations](https:\/\/www.home-assistant.io\/docs\/automation\/)\n  - [Dashboards](https:\/\/www.home-assistant.io\/dashboards\/)\n  - [Voice assistants](https:\/\/www.home-assistant.io\/voice_control\/)\n  - [Device organization](https:\/\/www.home-assistant.io\/docs\/organizing\/)\n  - [Energy management](https:\/\/www.home-assistant.io\/docs\/energy\/)\n  - [Templating](https:\/\/www.home-assistant.io\/docs\/templating\/)\n  - [Advanced configuration](https:\/\/www.home-assistant.io\/docs\/configuration\/)\n- [Our hardware](https:\/\/www.home-assistant.io\/common-tasks\/os\/)\n  - [Home Assistant Green](https:\/\/www.home-assistant.io\/green\/)\n  - [Connect ZBT-2](https:\/\/www.home-assistant.io\/connect\/zbt-2\/)\n  - [Connect ZWA-2](https:\/\/www.home-assistant.io\/connect\/zwa-2\/)\n  - [Voice Preview Edition](https:\/\/www.home-assistant.io\/voice-pe\/)\n- [Integrations](https:\/\/www.home-assistant.io\/integrations\/)\n- [Blog](https:\/\/www.home-assistant.io\/blog\/)\n- [Need help?](https:\/\/www.home-assistant.io\/help\/)\n\nOn this page\n\n- [Configuring access to files](https:\/\/www.home-assistant.io\/common-tasks\/os\/#configuring-access-to-files)\n  - [Installing and using the Samba app](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-samba-app)\n  - [Installing and using the Visual Studio Code (VSC) app](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-visual-studio-code-vsc-app)\n  - [Installing and using the File Editor app](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-file-editor-app)\n  - [Installing and using the SSH app](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-ssh-app)\n- [Backup](https:\/\/www.home-assistant.io\/common-tasks\/os\/#backup)\n  - [Alternative: Creating a backup using the Home Assistant Command Line Interface](https:\/\/www.home-assistant.io\/common-tasks\/os\/#alternative-creating-a-backup-using-the-home-assistant-command-line-interface)\n- [Updating Home Assistant](https:\/\/www.home-assistant.io\/common-tasks\/os\/#updating-home-assistant)\n  - [Updating the Home Assistant Operating System](https:\/\/www.home-assistant.io\/common-tasks\/os\/#updating-the-home-assistant-operating-system)\n  - [Updating Home Assistant Core](https:\/\/www.home-assistant.io\/common-tasks\/os\/#updating-home-assistant-core)\n- [Network storage](https:\/\/www.home-assistant.io\/common-tasks\/os\/#network-storage)\n  - [Add a new network storage](https:\/\/www.home-assistant.io\/common-tasks\/os\/#add-a-new-network-storage)\n  - [Change default local backup location](https:\/\/www.home-assistant.io\/common-tasks\/os\/#change-default-local-backup-location)\n- [Lost Password and password reset](https:\/\/www.home-assistant.io\/common-tasks\/os\/#lost-password-and-password-reset)\n- [Installing a third-party app repository](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-a-third-party-app-repository)\n  - [Troubleshooting: Repository is not showing up](https:\/\/www.home-assistant.io\/common-tasks\/os\/#troubleshooting-repository-is-not-showing-up)\n- [Configuration check](https:\/\/www.home-assistant.io\/common-tasks\/os\/#configuration-check)\n  - [Running a configuration check from the UI](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-configuration-check-from-the-ui)\n  - [Running a configuration check from the CLI](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-configuration-check-from-the-cli)\n- [Home Assistant versions](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-versions)\n  - [Feature preview](https:\/\/www.home-assistant.io\/common-tasks\/os\/#feature-preview)\n  - [Running a beta version](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-beta-version)\n  - [Running a development version](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-development-version)\n  - [Running a specific version](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-specific-version)\n- [Using external data disk](https:\/\/www.home-assistant.io\/common-tasks\/os\/#using-external-data-disk)\n  - [Using UI to move the data partition](https:\/\/www.home-assistant.io\/common-tasks\/os\/#using-ui-to-move-the-data-partition)\n  - [Using CLI to move the data partition](https:\/\/www.home-assistant.io\/common-tasks\/os\/#using-cli-to-move-the-data-partition)\n  - [Migrating an external data disk to another system](https:\/\/www.home-assistant.io\/common-tasks\/os\/#migrating-an-external-data-disk-to-another-system)\n- [Home Assistant via the command line](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-via-the-command-line)\n  - [Home Assistant](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant)\n  - [Supervisor](https:\/\/www.home-assistant.io\/common-tasks\/os\/#supervisor)\n  - [Host](https:\/\/www.home-assistant.io\/common-tasks\/os\/#host)\n  - [Hardware](https:\/\/www.home-assistant.io\/common-tasks\/os\/#hardware)\n  - [Usage examples](https:\/\/www.home-assistant.io\/common-tasks\/os\/#usage-examples)\n  - [Console access](https:\/\/www.home-assistant.io\/common-tasks\/os\/#console-access)\n- [Enable duplicate log file](https:\/\/www.home-assistant.io\/common-tasks\/os\/#enable-duplicate-log-file)\n- [Enable I2C](https:\/\/www.home-assistant.io\/common-tasks\/os\/#enable-i2c)\n  - [Enable I2C with an SD card reader](https:\/\/www.home-assistant.io\/common-tasks\/os\/#enable-i2c-with-an-sd-card-reader)\n  - [Enable I2C via Home Assistant Operating System Terminal](https:\/\/www.home-assistant.io\/common-tasks\/os\/#enable-i2c-via-home-assistant-operating-system-terminal)\n  - [Troubleshooting](https:\/\/www.home-assistant.io\/common-tasks\/os\/#troubleshooting)\n- [Related topics](https:\/\/www.home-assistant.io\/common-tasks\/os\/#related-topics)\n\n[Home](https:\/\/www.home-assistant.io\/) ▸ [Common tasks](https:\/\/www.home-assistant.io\/common-tasks\/)\n\n# Common tasks - Operating System\n\nThis section will provide guides to some common tasks and information which you will need in order to run, maintain, and edit your Home Assistant OS system. For further details on any particular subject, make sure to refer to the documentation for specific apps (formerly known as add-ons) or topics listed here.\n\n## Configuring access to files\nYour Home Assistant Operating server includes two repositories by default: The official core app repository, and the community app repository. All of the apps mentioned here can be installed by navigating to the app store using [**Settings** \\> **Apps** \\> **Install app**](https:\/\/my.home-assistant.io\/redirect\/supervisor_store) in the UI.\n\nOne of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several apps commonly used for this, and most users employ a mix of various apps. Default directories on the host are mapped to the apps so that they can be accessed by the services any particular app might provide. On the host system these directories exist on the `\/data` partition at `\/mnt\/data\/supervisor\/`.\n\nUsing any of the apps listed below, the following directories are made available for access:\n\n- `addons`\n- `backup`\n- `config`\n- `media`\n- `share`\n- `ssl`\n***\n### Installing and using the Samba app\nThe **Samba** app allows you to share the directories on Home Assistant with other systems on your network. After installing the app, you can then also edit files using the editor of your preference from your client computer. This app can be installed from the app store’s official repository.\n\nTo install the app, follow these steps:\n\n1. Go to [**Settings** \\> **Apps** \\> **Samba share**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon?addon=core_samba) and select **Install**.\n2. On the **Configuration** tab, define **Username** and **Password**, store them in a safe place, and save your changes.\n   - You can specify any username and password.\n   - They are not related to the login credentials you use to log in to Home Assistant or to log in to the computer from which you are accessing the files.\n   - The app won’t start if username and password are not defined.\n3. For further configuration information, refer to the **Documentation** tab.\n4. To start the app, on the **Information** tab, select **Start**.\n\nTo access the Home Assistant directories from the other device, follow these steps:\n\n1. Go to [**Settings** \\> **System** \\> **Network**](https:\/\/my.home-assistant.io\/redirect\/network) and take note of the **Host name**.\n   - Alternatively, you can look up the host name or IP address of your Home Assistant on your router.\n2. How you connect from another device to Home Assistant depends on your system. Use one of the following options:\n   - **On Windows**: Open **File Explorer** and in the address bar, enter the IP address or hostname with two backslashes as `\\\\your.ha.ip.address` or `\\\\hostname`.\n     ![Screenshot of File Explorer displaying the navigation to a file share using an IP address](https:\/\/www.home-assistant.io\/images\/hassio\/screenshots\/file_explorer.png) Screenshot of File Explorer displaying the navigation to a file share using an IP address\n   - **On OS X**: Open **Finder** and select **Go** \\> **Connect to Server…** and enter the IP address or hostname as `smb:\/\/your.ha.ip.address` or `smb:\/\/hostname`.\n   - **On Ubuntu**: Open **Files** and in the address bar, enter the IP address or hostname as `smb:\/\/your.ha.ip.address` or `smb:\/\/hostname`.\n3. Enter the credentials you entered in the **Samba** app configuration.\n   - You also have the option of having the credentials stored so that you do not need to enter them again.\n4. Done! You now have access to the directories which you can then mount as a drive or pin to Quick Access.\n***\n### Installing and using the Visual Studio Code (VSC) app\nThe **Studio Code Server** app provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64\/ARM64 machines. The app also provides access to the Home Assistant Command Line Interface (CLI) using VSC’s built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and apps, creating\/restoring backups, and more. (See [Home Assistant via Command Line](https:\/\/www.home-assistant.io\/hassio\/commandline\/) for further info).\n\n![Screenshot of an example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.](https:\/\/www.home-assistant.io\/images\/docs\/configuration\/config-yaml_via-vscode.png) Example of a configuration.yaml file, accessed using the Studio Code Server app on a Home Assistant Operating System installation.\n\nTo install and use the **Studio Code Server** in Home Assistant, follow these steps:\n\n1. To install the app, go to [**Settings** \\> **Apps** \\> **Studio Code Server**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon?addon=a0d7b954_vscode) and install the app.\n2. Once you have the app installed, if you want, select the **Show in sidebar** option. Then, select **Start**.\n3. For information on configuration settings, open the **Documentation** tab.\n4. To start browsing, on the **Info** tab, select **Open Web UI**.\n***\n### Installing and using the File Editor app\nThe **File Editor** app is a web-based file system browser and text editor. It is a more basic and light weight alternative to Visual Studio Code. YAML files are automatically checked for syntax errors while editing.\n\n![Screenshot of an example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.](https:\/\/www.home-assistant.io\/images\/docs\/configuration\/config-yaml_via-file-editor.png) Example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.\n\nTo install and use the File Editor in Home Assistant, follow these steps:\n\n1. To install the app, go to [**Settings** \\> **Apps** \\> **File editor**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon?addon=core_configurator).\n   - Once you have the app installed, you can edit files within your `\/config` directory.\n2. If you want to be able to access directories outside the `\/config` directory, you need to disable an option in the app configuration.\n   - Go to the app under [**Settings** \\> **Apps** \\> **File editor**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon?addon=core_configurator).\n   - Open the **Configuration** tab.\n   - In the configuration settings, disable the **Enforce basepath** option.\n   - Note: The **Enforce basepath** option is intended to protect you from inadvertently making changes to settings files.\n3. For information on other configuration settings, open the **Documentation** tab.\n4. To confirm your changes, select **Save**.\n5. To start browsing, on the **Info** tab, select **Open Web UI**.\n***\n### Installing and using the SSH app\nIf you want to use the Home Assistant command line or an SSH client, you can do this through the **Terminal & SSH** app.\n\nThe **Terminal & SSH** app provides the following functionalities:\n\n- It provides a web terminal that you can access from the Home Assistant user interface.\n- It allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and apps, creating\/restoring backups, and more.\n  - For a list of command line commands, refer to [Home Assistant via Command Line](https:\/\/www.home-assistant.io\/common-tasks\/os#home-assistant-via-the-command-line).\n- It allows connecting to your system using an SSH client.\n- It also includes common tools like nano and vi editors.\n- The Terminal & SSH app does **not provide** access to the underlying host file system.\n\nTo get started with the **Terminal & SSH** app, follow these steps:\n\n1. In the bottom left, select your user to open the [**Profile**](https:\/\/my.home-assistant.io\/redirect\/profile) page. Make sure **Advanced Mode** is enabled.\n2. To install the app, go to the app store under [**Settings** \\> **Apps**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon\/?addon=core_ssh) and install the **Terminal & SSH** app.\n3. To use the web terminal, **start** the app, then select **Open Web UI**.\n   - You can now start typing your [commands](https:\/\/www.home-assistant.io\/common-tasks\/os#home-assistant-via-the-command-line).\n4. If you want to access from an ssh client, you need to enter credentials:\n   - Open the **Configuration** page.\n   - Enter a password or authorized Keys.\n   - Then save and start the app.\n## Backup\nTo learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under [common tasks](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups).\n\n### Alternative: Creating a backup using the Home Assistant Command Line Interface\nIn general, to create or restore from a backup, follow the steps described under [common tasks](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups). However, If you have the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you can also create a backup from the command line. Follow these steps:\n\n1. `ha backups list` - lists backups and their slugnames\n2. `ha backups restore slugname` - restores a specific backup\n3. `ha backups new --name nameofbackup` - create a backup\n\nFor additional information about command line usage, use the `ha help` command or refer to the [Home Assistant Command Line documentation](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-via-the-command-line).\n\n## Updating Home Assistant\nIf you have the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you receive update notifications from different components:\n\n- Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\n- Home Assistant SupervisorThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System.\n- Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated.\n- AppsApps are additional standalone third-party software packages that can be installed on Home Assistant OS. [\\[Learn more\\]](https:\/\/www.home-assistant.io\/getting-started\/concepts-terminology\/#apps), if you have any installed\n\nEach of these components needs to be updated separately.\n\n### Updating the Home Assistant Operating System\nUpdates of the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. are independent of other updates. They do not trigger repair issues and are usually backward-compatible.\n\n#### Prerequisites\n- [Backup your installation](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups).\n  - Make sure the backup is stored on a [backup location](https:\/\/www.home-assistant.io\/common-tasks\/general\/#defining-backup-locations) outside of the device where Home Assistant is installed.\n    - For example, if Home Assistant is installed on [Home Assistant Green](https:\/\/www.home-assistant.io\/green), make sure it is stored on [Home Assistant Cloud](https:\/\/www.home-assistant.io\/common-tasks\/general\/#about-the-backup-storage-on-home-assistant-cloud) or another location.\n  - So that you can [restore from that backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#restoring-a-backup) in case there is an issue with the system.\n#### To update the Home Assistant Operating System\nUsing the UI\n\nUsing the CLI\n\n1. Open the **Settings** panel.\n2. On the top you will be presented with an update notification.\n   - Troubleshooting: If you do not see that notification:\n     - In the top right corner, select the three dots\n       menu and select **Check for updates**.\n     - Go to [**System** \\> **Updates**](https:\/\/my.home-assistant.io\/redirect\/updates).\n       - Select the update notification.\n       - Select the cogwheel\n         , then set **Visible** to active.\n3. Open the notification for the component you want to update.\n4. If you want to update the system first (recommended), enable the backup toggle.\n5. Select **Update**.\n6. Check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed.\n\n```\nha os update\n```\n*This updates to the latest version. If you want to update to a specific version instead, use `ha os update --version 15.2`.*\n\nAdvanced: changing the boot slot used during the update\n\n#### About boot slots used during the update\nThe Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. uses two boot slots. On first installation, boot slot A is used. After that, on each Operating System update, the other boot slot is updated and reboot is triggered. On that reboot, the system boots from the other boot slot (A ➝ B ➝ A,…). When booting fails, the system automatically uses the previous boot slot, so that it boots from the last working operating system.\n\n#### Changing the boot slot used\nYou can manually define that the previous boot slot is used. This can be useful in cases where the system boots but something still seems wrong. For example, when the device is no longer correctly detected or you see another issue that might be related to the latest update of the operating system.\n\n1. To check which boot slot is currently in use and what OS versions are installed in the individual slots, in the Home Assistant command line, enter the following command:\n   ```\n   ha os info\n   ```\n2. To change the boot slot, enter the following command:\n   - This will boot into the other (previous) OS version.\n   ```\n   ha os boot-slot other\n   ```\n\nAlternatively, if the Operating Systems runs on a platform that uses the GRUB bootloader, a boot menu is presented early in the boot. The alternative boot slot can be selected here, marking it active for future boots if the following boot attempt is successful.\n### Updating Home Assistant Core\n#### Prerequisites\n1. [Back up your installation](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups) and store the backup and the [backup emergency kit](https:\/\/www.home-assistant.io\/more-info\/backup-emergency-kit\/) somewhere safe.\n   - This ensures that you can [restore your installation from backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#restoring-a-backup) if needed.\n2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](https:\/\/www.home-assistant.io\/blog\/categories\/core\/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` \/ `CMD + f`) and search for **Backward-incompatible changes**.\n#### To update Home Assistant Core\nTo update Home Assistant Core, choose one of the following options.\n\nUsing the UI\n\nUsing the CLI\n\n1. Open your Home Assistant UI.\n2. Go to the **Settings** panel.\n3. On the top you will be presented with an update notification.\n\n- Troubleshooting: If you do not see that notification:\n  - In the top right corner, select the three dots\n    menu and select **Check for updates**.\n  - Go to [**System** \\> **Updates**](https:\/\/my.home-assistant.io\/redirect\/updates).\n    - Select the update notification.\n    - Select the cogwheel\n      , then set **Visible** to active.\n\n1. Open the notification for the component you want to update.\n2. If you want to backup the system first (recommended), enable the backup toggle.\n3. Select **Update**.\n4. After the update completed, check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed.\n\n```\nha core update --backup\n```\n*The* `--backup` *flag here ensures that you have a partial backup of your current setup in case you need to downgrade.*\n## Network storage\nYou can configure both Network File System (NFS) and Samba\/Windows (CIFS) targets to be used within Home Assistant and apps. To list all your currently connected network storages, go to **[Settings \\> System \\> Storage](https:\/\/my.home-assistant.io\/redirect\/storage)** in the UI.\n\nImportant\n\nYou need to update to Home Assistant Operating System 10.2 before you can use this feature.\n\n![](https:\/\/www.home-assistant.io\/images\/screenshots\/network-storage\/list_light.png) Screenshot of the list of network shares inside the storage panel.\n\n### Add a new network storage\n1. Go to **[Settings \\> System \\> Storage](https:\/\/my.home-assistant.io\/redirect\/storage)** in the UI.\n2. Select **Add network storage**.\n3. Fill out all the information for your network storage.\n4. Select **Connect**.\n\n![](https:\/\/www.home-assistant.io\/images\/screenshots\/network-storage\/connect_light.png) Screenshot of connecting a new network storage.\n\n#### Network storage configuration\nName\n\nThis is the name that will be used for the mounted directory on your system.\n\nUsage\n\nHere, you select how the target should be used. [See usage types below](https:\/\/www.home-assistant.io\/common-tasks\/os\/#usage-types)\n\nServer\n\nThe IP\/hostname of the server running NFS\/CIFS.\n\nProtocol3\n\nThe service the server is using for the network storage.\n\n\\[NFS\\]1 Remote share path\n\nThe path used to connect to the remote storage server.\n\n\\[CIFS\\]2 Username\n\nThe username to use when connecting to the storage server. Use User Principal Name for domain accounts. For example: `[email protected]`.\n\n\\[CIFS\\]2 Password\n\nThe password to use when connecting to the storage server.\n\n\\[CIFS\\]2 Share\n\nThe share to connect to on the storage server.\n\n1 *Options prefixed with `[NFS]` are only available for NFS targets.*  \n 2 *Options prefixed with `[CIFS]` are only available for CIFS targets.*  \n 3 *For the `CIFS` option, only version 2.1+ is supported.*\n\n##### Usage types\nBackup\n\nThis will become a target. You can use it when creating an automatic or manual backup. The first storage you add of this type becomes your new default target. If you want to change the default target, [check out the documentation below](https:\/\/www.home-assistant.io\/common-tasks\/os\/#change-default-local-backup-location).\n\nMedia\n\nA new directory with the name you gave your network storage will be created under `\/media`. This directory can be accessed by Home Assistant and apps.\n\nShare\n\nA new directory with the name you gave your network storage will be created under `\/share`. This directory can be accessed by Home Assistant and apps.\n### Change default local backup location\nBy default, the first network storage of type **Backup** that you add is used as your local default backup location.\n\nIf you want to change the local network storage that is used to store your backups, follow these steps:\n\n1. Go to **[Settings \\> System \\> Backups](https:\/\/my.home-assistant.io\/redirect\/backup)**.\n2. Select **Settings and history**.\n3. In the top-right corner, select the three dots\n   menu and select **Change default action location**.\n4. Select your preferred network location and save your changes. ![Select default location used for local backup](https:\/\/www.home-assistant.io\/images\/screenshots\/network-storage\/backup_select_local_default.png)\n5. Troubleshooting: Don’t see your external storage location? This list contains only the network storage targets you have added of type **Backup**.\n## Lost Password and password reset\nPlease refer to the [I’m locked out\\!](https:\/\/www.home-assistant.io\/docs\/locked_out\/) documentation page.\n\n## Installing a third-party app repository\nHome Assistant allows anyone to create an app repository to share their own apps with the community.\n\nWarning\n\nHome Assistant cannot guarantee the quality or security of third-party apps. Use at your own risk.\n\nTo add an app repository, follow these steps:\n\n1. Copy the URL of the repository.\n   - The URL is the git repository clone URL (on GitHub, use the Code button and copy the HTTPS URL).\n   - This documentation uses an example app repository. It is not practically useful but follows the same steps.\n   - If you are interested in app development, refer to our [Home Assistant app development documentation](https:\/\/developers.home-assistant.io\/docs\/apps\/).\n     ```\n     https:\/\/github.com\/home-assistant\/hassio-addons-example\n     ```\n2. Go to [**Settings** \\> **Apps**](https:\/\/my.home-assistant.io\/redirect\/supervisor) and select **App store**. ![Screenshot of the Home Assistant app store](https:\/\/www.home-assistant.io\/images\/getting-started\/app-store.png)\n3. In the top-right corner, select the three dots\n   menu, and select **Repositories**.\n4. Add the URL of the repository and select **Add**. ![Screenshot of the app store](https:\/\/www.home-assistant.io\/images\/getting-started\/adding_repositories-url.png)\n   - Result: A new card for the third-party repository will appear. ![Screenshot of the app store](https:\/\/www.home-assistant.io\/images\/getting-started\/add-ons-community_example.png)\n### Troubleshooting: Repository is not showing up\nIf you have added an app repository, but it’s not showing up, make sure to refresh your browser. If it still doesn’t show up, the app repository may contain invalid configuration data.\n\n1. Go to [**Settings** \\> **System** \\> **Logs**](https:\/\/my.home-assistant.io\/redirect\/logs) and select Supervisor in the top right corner to get the Supervisor log.\n   - It should tell you what went wrong.\n2. Report this information to the app repository author.\n## Configuration check\nAfter changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core.\n\n### Running a configuration check from the UI\n1. Go to [your user profile](https:\/\/my.home-assistant.io\/redirect\/profile) and enable **Advanced Mode**.\n2. Go to [**Settings** \\> **Developer tools** \\> **YAML**](https:\/\/my.home-assistant.io\/redirect\/server_controls) and in the **Configuration validation** section, select the **Check configuration** button.\n   - This is to make sure there are no syntax errors before restarting Home Assistant.\n   - It checks for valid YAMLYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the `configuration.yaml` or `automations.yaml` files. [\\[Learn more\\]](https:\/\/www.home-assistant.io\/docs\/configuration\/yaml\/) and valid config structures.\n3. If you need to do a more comprehensive configuration check, [run the check from the CLI](https:\/\/www.home-assistant.io\/common-tasks\/os\/#to-run-a-configuration-check-from-the-cli).\n### Running a configuration check from the CLI\nUse the following command to check if the configuration is valid. The command line configuration check validates the YAMLYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the `configuration.yaml` or `automations.yaml` files. [\\[Learn more\\]](https:\/\/www.home-assistant.io\/docs\/configuration\/yaml\/) files and checks for valid config structures, as well as some other elements.\n```\nha core check\n```\n## Home Assistant versions\nTo see which version your system is running, go to [**Settings** \\> **About**](https:\/\/my.home-assistant.io\/redirect\/info).\n\n### Feature preview\nIf you want to preview upcoming features, you can enable preview under [**Settings** \\> **System** \\> **Labs**](https:\/\/my.home-assistant.io\/redirect\/labs).\n\n**Labs** allows you to preview selected features that are stable but are still being fine-tuned. Preview is different from installing a beta or development version, which are used for development and testing.\n\nFor more information, refer to the [Labs documentation](https:\/\/www.home-assistant.io\/integrations\/labs).\n\n### Running a beta version\nIf you would like to test next release before anyone else, you can install the beta version.\n\nFrom the UI\n\nFrom the CLI\n\n1. In Home Assistant, go to [**System** \\> **Updates**](https:\/\/my.home-assistant.io\/redirect\/updates).\n2. In the top-right corner, select the three dots\n   menu.\n3. Select **Join beta**.\n4. Go to the [**Configuration**](https:\/\/my.home-assistant.io\/redirect\/configuration) panel.\n5. Install the update that is presented to you.\n   - Troubleshooting: If you do not see that notification:\n     - In the top right corner, select the three dots\n       menu and select **Check for updates**.\n     - Go to [**System** \\> **Updates**](https:\/\/my.home-assistant.io\/redirect\/updates).\n       - Select the update notification.\n       - Select the cogwheel\n         , then set **Visible** to active.\n\n1. Join the beta channel.\n   ```\n   ha supervisor options --channel beta\n   ```\n2. Reload Home Assistant Supervisor.\n   ```\n   ha supervisor reload\n   ```\n3. Update Home Assistant Core to the latest beta version.\n   ```\n   ha core update --backup\n   ```\n   *The* `--backup` *flag here ensures that you have a partial backup of your current setup in case you need to downgrade.*\n### Running a development version\nIf you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to `dev`.\n\nCaution\n\nThe `dev` branch is likely to be unstable. Potential consequences include loss of data and instance corruption.\n\n1. Join the dev channel.\n   ```\n   ha supervisor options --channel dev\n   ```\n2. Reload the Home Assistant SupervisorThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System..\n   ```\n   ha supervisor reload\n   ```\n3. Update Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated. to the latest dev version.\n   ```\n   ha core update --backup\n   ```\n   *The* `--backup` *flag here ensures that you have a partial backup of your current setup incase you need to downgrade.*\n### Running a specific version\nTo upgrade to a specific version, you can use the command line (CLI). The example below shows how to upgrade to `2026.4.1`. To learn how to get started with the command line in Home Assistant, refer to the [SSH app setup instructions](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-ssh-app).\n```\nha core update --version 2026.4.1 --backup\n```\n*The* `--backup` *flag here ensures that you have a partial backup of your current setup in case you need to downgrade later.*\n\nTo downgrade your installation, do a [partial restore of a backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups) instead.\n\n## Using external data disk\nHome Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. supports storing data on a secondary storage medium. For example, this can be a second internal SSD or HDD or a USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster.\n\n![Graphics showing the architecture of the data disk feature](https:\/\/www.home-assistant.io\/images\/haos\/usb-data-disk.png)\n\nThe data disk feature can be used on an existing installation without losing data: The system will move existing data to the external data disk automatically. However, it is recommended to create and download a full [Backup](https:\/\/www.home-assistant.io\/common-tasks\/os\/#backups) before proceeding\\!\n\nCaution\n\nAll data on the target disk will be overwritten\\!\n\nImportant\n\nThe storage capacity of the external data disk must be larger than the storage capacity of the existing (boot) disk.\n\nImportant\n\nIf you have been using a data disk previously with Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., you need to use your host computer to delete all partitions *before* using it as a data disk again.\n### Using UI to move the data partition\n1. Connect the data disk to your system.\n2. Go to **[Settings \\> System \\> Storage](https:\/\/my.home-assistant.io\/redirect\/storage)** in the UI.\n3. Select **Move data disk**.\n4. Select the data disk from the list of available devices.\n5. Select **Move**.\n   - Depending on the amount of data, this may take a while.\n### Using CLI to move the data partition\nTo see the current data disk use:\n```\n$ ha os info\n...\ndata_disk: \/dev\/mmcblk1p4\n...\n```\nTo get a list of potential targets which can be used by `datadisk`:\n```\nha os datadisk list\n```\nTo initiate the move to the new data disk use the `move` command:\n```\nha os datadisk move \/dev\/sdx\n```\nThe system will prepare the data disk and immediately reboot. The reboot will take 10 minutes or more depending on the speed of the new data disk; please be patient\\!\n\nWarning\n\nUsing an USB attached SSD can draw quite some power. For instance on Raspberry Pi 3 the official Raspberry Pi power supply (PSU) only provides 2.5A which can be too tight. Use a more powerful power supply if you experience issues. Alternatively use a powered USB hub. Connect the Hub to one of the USB slots of your Raspberry Pi, and connect the SSD to the Hub. In this setup the power supply of the Hub will power the attached device(s).\n### Migrating an external data disk to another system\nThis section shows how to move an external data disk from one system to another. This can be an option if the following elements apply to your use case:\n\n- You already have a functioning Home Assistant instance (system 1) that is using an external data disk.\n- You have another, new, Home Assistant instance (system 2).\n- You now want to use the data disk of system 1 on system 2 instead.\n\nThe aim is to migrate the data from system 1 to system 2. One way to do this is by [restoring a backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#restoring-a-backup). The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk or if your external disk has more storage capacity than your new system.\n\n#### Prerequisites\n- A Home Assistant instance using an external data disk (system 1)\n- A Home Assistant instance to which you want to move the external data disk (system 2)\n#### To migrate an external data disk to another system\nTo migrate an external data disk from one system to another, follow these steps:\n\n1. [Create a backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups) of both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data).\n2. Shut down system 1 and remove the data disk.\n3. Make sure system 2 has Home Assistant OS installed, and Home Assistant is up and running. Home Assistant is using the data disk (partition) on the boot drive (e.g. SD card) at this point.\n4. Make sure system 2 has completed the basic [onboarding](https:\/\/www.home-assistant.io\/getting-started\/onboarding\/) steps, including the last steps where devices are discovered automatically.\n5. Plug the external disk into system 2 and go to the **Settings** \\> **System**. Select the three dots\n   menu, and **Restart Home Assistant** \\> **Reboot system**. Result: A repair issue is displayed **Multiple data disks detected**.\n   - The repair issue comes up because system 2 now sees two file systems with an identical name. During a reboot, there is a name conflict with the existing data disk as it is undefined which file system should be used. This can lead to a random selection of the system you end up with. Hence you must make a decision.\n6. Open the repair issue and choose one of the options:\n   - Select **Use the detected data disk instead of the current system**.\n     - This will override the current file system of system 2 and use your external data disk instead.\n     - You won’t have access anymore to the current Home Assistant data. It will be marked as inactive data disk.\n   - If you changed your mind about using the external data disk:\n     - Unplug the external data disk.\n     - If you cannot unplug the external data disk for some reason, select **Mark as inactive data disk (rename file system)**.\n       - This makes sure that there is no name conflict after rebooting.\n       - It also means you cannot use the file system that is stored on your external disk.\n       - You keep using the current file system of system 1.\n## Home Assistant via the command line\nOn the [SSH command line](https:\/\/www.home-assistant.io\/common-tasks\/os\/), you can use the `ha` command to retrieve logs, check the details of connected hardware, and more.\n\n### Home Assistant\n```\nha core check\nha core info\nha core logs\nha core options\nha core rebuild\nha core restart\nha core restart --safe-mode\nha core start\nha core stats\nha core stop\nha core update\n```\n### Supervisor\n```\nha supervisor info\nha supervisor logs\nha supervisor reload\nha supervisor update\n```\n### Host\n```\nha host reboot\nha host shutdown\nha host update\n```\n### Hardware\n```\nha hardware info\nha hardware audio\n```\n### Usage examples\nTo update Home Assistant to a specific version, use the command:\n```\nha core update --version x.y.z\n```\nReplace x.y.z with the desired version like `--version 2026.4.1`\n\nYou can get a better description of the CLI capabilities by typing `ha help`:\n```\nThe Home Assistant CLI is a small and simple command line utility that allows\nyou to control and configure different aspects of Home Assistant\n\nUsage:\n  ha [command]\n\nAvailable Commands:\n  addons         Install, update, remove and configure Home Assistant apps\n  audio          Audio device handling.\n  authentication Authentication for Home Assistant users.\n  backups        Create, restore and remove backups\n  banner         Prints the CLI Home Assistant banner along with some useful information\n  cli            Get information, update or configure the Home Assistant cli backend\n  core           Provides control of the Home Assistant Core\n  dns            Get information, update or configure the Home Assistant DNS server\n  docker         Docker backend specific for info and OCI configuration\n  hardware       Provides hardware information about your system\n  help           Help about any command\n  host           Control the host\/system that Home Assistant is running on\n  info           Provides a general Home Assistant information overview\n  jobs           Get information and manage running jobs\n  multicast      Get information, update or configure the Home Assistant Multicast\n  network        Network specific for updating, info and configuration imports\n  observer       Get information, update or configure the Home Assistant observer\n  os             Operating System specific for updating, info and configuration imports\n  resolution     Resolution center of Supervisor, show issues and suggest solutions\n  supervisor     Monitor, control and configure the Home Assistant Supervisor\n\nFlags:\n      --api-token string   Home Assistant Supervisor API token\n      --config string      Optional config file (default is $HOME\/.homeassistant.yaml)\n      --endpoint string    Endpoint for Home Assistant Supervisor (default is 'supervisor')\n  -h, --help               help for ha\n      --log-level string   Log level (defaults to Warn)\n      --no-progress        Disable the progress spinner\n      --raw-json           Output raw JSON from the API\n\nUse \"ha [command] --help\" for more information about a command.\n```\n### Console access\nYou can also access the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. via a directly connected keyboard and monitor, the console.\n\n#### Wiping the data disk from the command line\nIn Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., the `ha os datadisk wipe` command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed apps.\n\nThe command `ha os datadisk wipe` marks the data partition (either internal on the eMMC or the SD card, or on an external attached data disk) as to be cleared on the next reboot. The command automatically reboots the system. Upon reboot, the data is cleared. Then the system continues to boot and reinstalls the latest version of all Home Assistant components.\n\nThe `ha os datadisk wipe` command can only be run from the local terminal. Connect a display and keyboard and use the terminal.\n\nNote, some systems have a reset button you can use to clear the data disk, instead of using the command line:\n\n- If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 5, use the command line steps described above.\n- If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 4, there is a red hardware button to wipe the data disk. Follow the procedure on [resetting the Home Assistant Yellow](https:\/\/support.nabucasa.com\/hc\/articles\/25463622043165).\n- If you have a Home Assistant Green, there is a black hardware button to wipe the data disk. Follow the procedure on [resetting the Home Assistant Green](https:\/\/support.nabucasa.com\/hc\/en-us\/articles\/25161225495837).\n#### Listing all users from the command line\nIn Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., the `ha auth list` command lists all users that are registered on your Home Assistant.\n\nThe `ha auth list` command can only be run from the local terminal. Connect a display and keyboard and use the terminal.\n\n## Enable duplicate log file\nBy default, Home Assistant Core logs are sent to the Systemd Journal, which can be read using the [`ha core logs` command](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-via-the-command-line). If you need logs to also be written to a file (`\/config\/home-assistant.log`), you can enable the duplicated log file option using the [command line](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-via-the-command-line):\n```\nha core options --duplicate-log-file=true\nha core rebuild\nha core restart\n```\nTo disable it:\n```\nha core options --duplicate-log-file=false\nha core rebuild\nha core restart\n```\n## Enable I2C\nHome Assistant using the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. which is a managed environment, which means you can’t use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to\n\n- Enable I2C for the Home Assistant Operating System\n- Setup I2C devices e.g. sensors\n### Enable I2C with an SD card reader\n#### Access the boot partition\nYou will need:\n\n- SD card reader\n- SD card with Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. flashed on it\n\nShutdown\/turn-off your Home Assistant installation and unplug the SD card. Plug the SD card into an SD card reader and find a drive\/file system named `hassos-boot`. The file system might be shown\/mounted automatically. If not, use your operating systems disk management utility to find the SD card reader and make sure the first partition is available.\n\n#### Add files to enable I2C\n- In the root of the `hassos-boot` partition, add a new folder called `CONFIG`.\n- In the `CONFIG` folder, add another new folder called `modules`.\n- Inside the `modules` folder add a text file called `rpi-i2c.conf` with the following content:\n  ```\n  i2c-dev\n  ```\n- In the root of the `hassos-boot` partition, edit the file called `config.txt` add two lines to it:\n  ```\n  dtparam=i2c_vc=on\ndtparam=i2c_arm=on\n  ```\n#### Start with the new OS configuration\n- Insert the SD card back into your Raspberry Pi.\n- On startup, the `hassos-config.service` will automatically pickup the new `rpi-i2c.conf` configuration.\n- Another reboot might be necessary to make sure the just imported `rpi-i2c.conf` is present at boot time.\n### Enable I2C via Home Assistant Operating System Terminal\nAlternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users..\n\nYou can enable I2C via this terminal:\n\n- Login as `root`.\n- Type `login` and press enter to access the shell:\n  ```\n  mkdir -p \/mnt\/boot\/CONFIG\/modules\necho i2c-dev > \/mnt\/boot\/CONFIG\/modules\/rpi-i2c.conf\necho dtparam=i2c_vc=on >> \/mnt\/boot\/config.txt\necho dtparam=i2c_arm=on >> \/mnt\/boot\/config.txt\nsync\nreboot\n  ```\n### Troubleshooting\nAfter rebooting the host there should be `i2c-0` and similar device files in `\/dev`. If such device files are missing, enabling I2C failed for some reason. You can check the status of I2C kernel modules by using `lsmod | grep i2c` in the terminal. If they are loaded, you should find at least the entry `i2c_dev`. Active usage of the modules is indicated by a number, e.g. `i2c_dev 20480 2` would indicate two active I2C device files.\n\nAn active I2C can also be checked with a multi meter showing 3.3 V on the I2C pins GPIO2 and GPIO3.\n\n## Related topics\n- [Configuration.yaml](https:\/\/www.home-assistant.io\/docs\/configuration\/)\n\n#### **Help us improve our documentation**\nSuggest an edit to this page, or provide\/view feedback for this page.\n\n- [Edit](https:\/\/github.com\/home-assistant\/home-assistant.io\/tree\/current\/source\/common-tasks\/os.markdown \"Edit this page\")\n- [Provide feedback](https:\/\/github.com\/home-assistant\/home-assistant.io\/issues\/new?template=feedback.yml&url=https%3A%2F%2Fwww.home-assistant.io%2Fcommon-tasks%2Fos%2F&version=2026.4.1&labels=current \"Provide feedback on this page\")\n- [View given feedback](https:\/\/github.com\/home-assistant\/home-assistant.io\/issues?utf8=%E2%9C%93&q=%22%2Fcommon-tasks%2Fos%2F%22&in=body \"View given feedback for this page\")\n\n## Documentation\n- [Overview](https:\/\/www.home-assistant.io\/docs\/)  \\| [FAQ](https:\/\/www.home-assistant.io\/faq\/)  \\| [Glossary](https:\/\/www.home-assistant.io\/docs\/glossary\/)\n- [Automations](https:\/\/www.home-assistant.io\/docs\/automation\/)\n- [Dashboards](https:\/\/www.home-assistant.io\/dashboards)\n- [Voice assistants](https:\/\/www.home-assistant.io\/voice_control\/)\n- [Organization](https:\/\/www.home-assistant.io\/docs\/organizing\/)\n- [Home energy management](https:\/\/www.home-assistant.io\/docs\/energy\/)\n- [Templating](https:\/\/www.home-assistant.io\/docs\/templating\/)\n- [Common tasks](https:\/\/www.home-assistant.io\/common-tasks\/general\/)\n  - [Installation independent](https:\/\/www.home-assistant.io\/common-tasks\/general\/)\n  - [Home Assistant Operating System](https:\/\/www.home-assistant.io\/common-tasks\/os\/)\n  - [Home Assistant Container](https:\/\/www.home-assistant.io\/common-tasks\/container\/)\n  - [General troubleshooting](https:\/\/www.home-assistant.io\/docs\/troubleshooting_general\/)\n- [Advanced configuration](https:\/\/www.home-assistant.io\/docs\/configuration\/)\n- [Authentication](https:\/\/www.home-assistant.io\/docs\/authentication\/)\n- [Backend](https:\/\/www.home-assistant.io\/docs\/backend\/)\n- [Tools and helpers](https:\/\/www.home-assistant.io\/docs\/tools\/)\n- [iOS and Android apps](https:\/\/companion.home-assistant.io\/docs)\n- [MQTT](https:\/\/www.home-assistant.io\/integrations\/mqtt)\n- Official hardware\n  - [Home Assistant Green](https:\/\/support.nabucasa.com\/hc\/categories\/24638797677853)\n  - [Home Assistant Connect ZBT-1](https:\/\/support.nabucasa.com\/hc\/categories\/24734620813469)\n  - [Home Assistant Connect ZBT-2](https:\/\/support.nabucasa.com\/hc\/categories\/29400540866973)\n  - [Home Assistant Connect ZWA-2](https:\/\/support.nabucasa.com\/hc\/categories\/28669861145885)\n  - [Home Assistant Yellow](https:\/\/support.nabucasa.com\/hc\/categories\/24734575925149)\n  - [Home Assistant Voice Preview Edition](https:\/\/support.nabucasa.com\/hc\/categories\/24451727188125)\n\n## On this page\n- [Configuring access to files](https:\/\/www.home-assistant.io\/common-tasks\/os\/#configuring-access-to-files)\n  - [Installing and using the Samba app](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-samba-app)\n  - [Installing and using the Visual Studio Code (VSC) app](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-visual-studio-code-vsc-app)\n  - [Installing and using the File Editor app](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-file-editor-app)\n  - [Installing and using the SSH app](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-ssh-app)\n- [Backup](https:\/\/www.home-assistant.io\/common-tasks\/os\/#backup)\n  - [Alternative: Creating a backup using the Home Assistant Command Line Interface](https:\/\/www.home-assistant.io\/common-tasks\/os\/#alternative-creating-a-backup-using-the-home-assistant-command-line-interface)\n- [Updating Home Assistant](https:\/\/www.home-assistant.io\/common-tasks\/os\/#updating-home-assistant)\n  - [Updating the Home Assistant Operating System](https:\/\/www.home-assistant.io\/common-tasks\/os\/#updating-the-home-assistant-operating-system)\n  - [Updating Home Assistant Core](https:\/\/www.home-assistant.io\/common-tasks\/os\/#updating-home-assistant-core)\n- [Network storage](https:\/\/www.home-assistant.io\/common-tasks\/os\/#network-storage)\n  - [Add a new network storage](https:\/\/www.home-assistant.io\/common-tasks\/os\/#add-a-new-network-storage)\n  - [Change default local backup location](https:\/\/www.home-assistant.io\/common-tasks\/os\/#change-default-local-backup-location)\n- [Lost Password and password reset](https:\/\/www.home-assistant.io\/common-tasks\/os\/#lost-password-and-password-reset)\n- [Installing a third-party app repository](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-a-third-party-app-repository)\n  - [Troubleshooting: Repository is not showing up](https:\/\/www.home-assistant.io\/common-tasks\/os\/#troubleshooting-repository-is-not-showing-up)\n- [Configuration check](https:\/\/www.home-assistant.io\/common-tasks\/os\/#configuration-check)\n  - [Running a configuration check from the UI](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-configuration-check-from-the-ui)\n  - [Running a configuration check from the CLI](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-configuration-check-from-the-cli)\n- [Home Assistant versions](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-versions)\n  - [Feature preview](https:\/\/www.home-assistant.io\/common-tasks\/os\/#feature-preview)\n  - [Running a beta version](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-beta-version)\n  - [Running a development version](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-development-version)\n  - [Running a specific version](https:\/\/www.home-assistant.io\/common-tasks\/os\/#running-a-specific-version)\n- [Using external data disk](https:\/\/www.home-assistant.io\/common-tasks\/os\/#using-external-data-disk)\n  - [Using UI to move the data partition](https:\/\/www.home-assistant.io\/common-tasks\/os\/#using-ui-to-move-the-data-partition)\n  - [Using CLI to move the data partition](https:\/\/www.home-assistant.io\/common-tasks\/os\/#using-cli-to-move-the-data-partition)\n  - [Migrating an external data disk to another system](https:\/\/www.home-assistant.io\/common-tasks\/os\/#migrating-an-external-data-disk-to-another-system)\n- [Home Assistant via the command line](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-via-the-command-line)\n  - [Home Assistant](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant)\n  - [Supervisor](https:\/\/www.home-assistant.io\/common-tasks\/os\/#supervisor)\n  - [Host](https:\/\/www.home-assistant.io\/common-tasks\/os\/#host)\n  - [Hardware](https:\/\/www.home-assistant.io\/common-tasks\/os\/#hardware)\n  - [Usage examples](https:\/\/www.home-assistant.io\/common-tasks\/os\/#usage-examples)\n  - [Console access](https:\/\/www.home-assistant.io\/common-tasks\/os\/#console-access)\n- [Enable duplicate log file](https:\/\/www.home-assistant.io\/common-tasks\/os\/#enable-duplicate-log-file)\n- [Enable I2C](https:\/\/www.home-assistant.io\/common-tasks\/os\/#enable-i2c)\n  - [Enable I2C with an SD card reader](https:\/\/www.home-assistant.io\/common-tasks\/os\/#enable-i2c-with-an-sd-card-reader)\n  - [Enable I2C via Home Assistant Operating System Terminal](https:\/\/www.home-assistant.io\/common-tasks\/os\/#enable-i2c-via-home-assistant-operating-system-terminal)\n  - [Troubleshooting](https:\/\/www.home-assistant.io\/common-tasks\/os\/#troubleshooting)\n- [Related topics](https:\/\/www.home-assistant.io\/common-tasks\/os\/#related-topics)\n\nBack to top\n\n![Home Assistant](https:\/\/www.home-assistant.io\/images\/footer-logo-text.svg)\n\nHome Assistant is a project from the [Open Home Foundation](https:\/\/www.openhomefoundation.org\/), sponsored by [Nabu Casa](https:\/\/www.nabucasa.com\/).\n\n### Join us and contribute\\!\n- [GitHub repo](https:\/\/github.com\/home-assistant\/)\n- [Developers Portal](https:\/\/developers.home-assistant.io\/)\n- [Design Portal](https:\/\/design.home-assistant.io\/)\n- [Data Science Portal](https:\/\/data.home-assistant.io\/)\n- [Community Forum](https:\/\/community.home-assistant.io\/)\n- [Creator Network](https:\/\/creators.home-assistant.io\/)\n- [Works With Home Assistant](https:\/\/works-with.home-assistant.io\/)\n- [Our community](https:\/\/www.home-assistant.io\/community)\n- [Reporting issues](https:\/\/www.home-assistant.io\/help\/reporting_issues\/)\n### System status\n- [Integration Alerts](https:\/\/alerts.home-assistant.io\/)\n- [Security Alerts](https:\/\/www.home-assistant.io\/security\/)\n- [System Status](https:\/\/status.home-assistant.io\/)\n\n### Companion apps\n- [iOS and Apple devices](https:\/\/apps.apple.com\/app\/id1099568401)\n- [Android and Wear OS](https:\/\/play.google.com\/store\/apps\/details?id=io.homeassistant.companion.android)\n- [...and more\\!](https:\/\/companion.home-assistant.io\/)\n### Support us\n- [Merch store](https:\/\/store.openhomefoundation.org\/)\n- [Home Assistant Cloud](https:\/\/www.home-assistant.io\/cloud\/)\n### Governance\n- [Privacy Notices](https:\/\/www.home-assistant.io\/privacy\/)\n- [Contributor License Agreement](https:\/\/www.home-assistant.io\/developers\/cla\/)\n- [Terms of Service](https:\/\/www.home-assistant.io\/tos\/)\n- [Code of Conduct](https:\/\/www.home-assistant.io\/code_of_conduct\/)\n- [Credits](https:\/\/www.home-assistant.io\/developers\/credits\/)\n- [License](https:\/\/www.home-assistant.io\/developers\/license\/)\n\n### Follow us\n[Sign up for our newsletter](https:\/\/newsletter.openhomefoundation.org\/#\/portal)\n\nFor partnership inquiries please check out [Works With Home Assistant](https:\/\/works-with.home-assistant.io\/). For media, [email our team](https:\/\/www.home-assistant.io\/cdn-cgi\/l\/email-protection#1c717978757d5c736c7972747371797a736972787d6875737232736e7b). For other questions, you can [contact support](https:\/\/www.home-assistant.io\/cdn-cgi\/l\/email-protection#80e8e5ececefc0e8efede5ade1f3f3e9f3f4e1eef4aee9ef) (No technical support!)\n\nWebsite powered by [Jekyll](https:\/\/jekyllrb.com\/)  \n Originally based on the [Oscailte theme](https:\/\/github.com\/coogie\/oscailte)\n\n[![Deploys by Netlify Badge](https:\/\/www.home-assistant.io\/images\/frontpage\/netlify.svg)](https:\/\/www.netlify.com\/)","attrs_readable_markdown":"This section will provide guides to some common tasks and information which you will need in order to run, maintain, and edit your Home Assistant OS system. For further details on any particular subject, make sure to refer to the documentation for specific apps (formerly known as add-ons) or topics listed here.\n\n## Configuring access to files\nYour Home Assistant Operating server includes two repositories by default: The official core app repository, and the community app repository. All of the apps mentioned here can be installed by navigating to the app store using [**Settings** \\> **Apps** \\> **Install app**](https:\/\/my.home-assistant.io\/redirect\/supervisor_store) in the UI.\n\nOne of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several apps commonly used for this, and most users employ a mix of various apps. Default directories on the host are mapped to the apps so that they can be accessed by the services any particular app might provide. On the host system these directories exist on the `\/data` partition at `\/mnt\/data\/supervisor\/`.\n\nUsing any of the apps listed below, the following directories are made available for access:\n\n- `addons`\n- `backup`\n- `config`\n- `media`\n- `share`\n- `ssl`\n***\n### Installing and using the Samba app\nThe **Samba** app allows you to share the directories on Home Assistant with other systems on your network. After installing the app, you can then also edit files using the editor of your preference from your client computer. This app can be installed from the app store’s official repository.\n\nTo install the app, follow these steps:\n\n1. Go to [**Settings** \\> **Apps** \\> **Samba share**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon?addon=core_samba) and select **Install**.\n2. On the **Configuration** tab, define **Username** and **Password**, store them in a safe place, and save your changes.\n   - You can specify any username and password.\n   - They are not related to the login credentials you use to log in to Home Assistant or to log in to the computer from which you are accessing the files.\n   - The app won’t start if username and password are not defined.\n3. For further configuration information, refer to the **Documentation** tab.\n4. To start the app, on the **Information** tab, select **Start**.\n\nTo access the Home Assistant directories from the other device, follow these steps:\n\n1. Go to [**Settings** \\> **System** \\> **Network**](https:\/\/my.home-assistant.io\/redirect\/network) and take note of the **Host name**.\n   - Alternatively, you can look up the host name or IP address of your Home Assistant on your router.\n2. How you connect from another device to Home Assistant depends on your system. Use one of the following options:\n   - **On Windows**: Open **File Explorer** and in the address bar, enter the IP address or hostname with two backslashes as `\\\\your.ha.ip.address` or `\\\\hostname`.\n     ![Screenshot of File Explorer displaying the navigation to a file share using an IP address](https:\/\/www.home-assistant.io\/images\/hassio\/screenshots\/file_explorer.png) Screenshot of File Explorer displaying the navigation to a file share using an IP address\n   - **On OS X**: Open **Finder** and select **Go** \\> **Connect to Server…** and enter the IP address or hostname as `smb:\/\/your.ha.ip.address` or `smb:\/\/hostname`.\n   - **On Ubuntu**: Open **Files** and in the address bar, enter the IP address or hostname as `smb:\/\/your.ha.ip.address` or `smb:\/\/hostname`.\n3. Enter the credentials you entered in the **Samba** app configuration.\n   - You also have the option of having the credentials stored so that you do not need to enter them again.\n4. Done! You now have access to the directories which you can then mount as a drive or pin to Quick Access.\n***\n### Installing and using the Visual Studio Code (VSC) app\nThe **Studio Code Server** app provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64\/ARM64 machines. The app also provides access to the Home Assistant Command Line Interface (CLI) using VSC’s built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and apps, creating\/restoring backups, and more. (See [Home Assistant via Command Line](https:\/\/www.home-assistant.io\/hassio\/commandline\/) for further info).\n\n![Screenshot of an example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.](https:\/\/www.home-assistant.io\/images\/docs\/configuration\/config-yaml_via-vscode.png) Example of a configuration.yaml file, accessed using the Studio Code Server app on a Home Assistant Operating System installation.\n\nTo install and use the **Studio Code Server** in Home Assistant, follow these steps:\n\n1. To install the app, go to [**Settings** \\> **Apps** \\> **Studio Code Server**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon?addon=a0d7b954_vscode) and install the app.\n2. Once you have the app installed, if you want, select the **Show in sidebar** option. Then, select **Start**.\n3. For information on configuration settings, open the **Documentation** tab.\n4. To start browsing, on the **Info** tab, select **Open Web UI**.\n***\n### Installing and using the File Editor app\nThe **File Editor** app is a web-based file system browser and text editor. It is a more basic and light weight alternative to Visual Studio Code. YAML files are automatically checked for syntax errors while editing.\n\n![Screenshot of an example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.](https:\/\/www.home-assistant.io\/images\/docs\/configuration\/config-yaml_via-file-editor.png) Example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.\n\nTo install and use the File Editor in Home Assistant, follow these steps:\n\n1. To install the app, go to [**Settings** \\> **Apps** \\> **File editor**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon?addon=core_configurator).\n   - Once you have the app installed, you can edit files within your `\/config` directory.\n2. If you want to be able to access directories outside the `\/config` directory, you need to disable an option in the app configuration.\n   - Go to the app under [**Settings** \\> **Apps** \\> **File editor**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon?addon=core_configurator).\n   - Open the **Configuration** tab.\n   - In the configuration settings, disable the **Enforce basepath** option.\n   - Note: The **Enforce basepath** option is intended to protect you from inadvertently making changes to settings files.\n3. For information on other configuration settings, open the **Documentation** tab.\n4. To confirm your changes, select **Save**.\n5. To start browsing, on the **Info** tab, select **Open Web UI**.\n***\n### Installing and using the SSH app\nIf you want to use the Home Assistant command line or an SSH client, you can do this through the **Terminal & SSH** app.\n\nThe **Terminal & SSH** app provides the following functionalities:\n\n- It provides a web terminal that you can access from the Home Assistant user interface.\n- It allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and apps, creating\/restoring backups, and more.\n  - For a list of command line commands, refer to [Home Assistant via Command Line](https:\/\/www.home-assistant.io\/common-tasks\/os#home-assistant-via-the-command-line).\n- It allows connecting to your system using an SSH client.\n- It also includes common tools like nano and vi editors.\n- The Terminal & SSH app does **not provide** access to the underlying host file system.\n\nTo get started with the **Terminal & SSH** app, follow these steps:\n\n1. In the bottom left, select your user to open the [**Profile**](https:\/\/my.home-assistant.io\/redirect\/profile) page. Make sure **Advanced Mode** is enabled.\n2. To install the app, go to the app store under [**Settings** \\> **Apps**](https:\/\/my.home-assistant.io\/redirect\/supervisor_addon\/?addon=core_ssh) and install the **Terminal & SSH** app.\n3. To use the web terminal, **start** the app, then select **Open Web UI**.\n   - You can now start typing your [commands](https:\/\/www.home-assistant.io\/common-tasks\/os#home-assistant-via-the-command-line).\n4. If you want to access from an ssh client, you need to enter credentials:\n   - Open the **Configuration** page.\n   - Enter a password or authorized Keys.\n   - Then save and start the app.\n## Backup\nTo learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under [common tasks](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups).\n\n### Alternative: Creating a backup using the Home Assistant Command Line Interface\nIn general, to create or restore from a backup, follow the steps described under [common tasks](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups). However, If you have the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you can also create a backup from the command line. Follow these steps:\n\n1. `ha backups list` - lists backups and their slugnames\n2. `ha backups restore slugname` - restores a specific backup\n3. `ha backups new --name nameofbackup` - create a backup\n\nFor additional information about command line usage, use the `ha help` command or refer to the [Home Assistant Command Line documentation](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-via-the-command-line).\n\n## Updating Home Assistant\nIf you have the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you receive update notifications from different components:\n\n- Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.\n- Home Assistant SupervisorThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System.\n- Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated.\n- AppsApps are additional standalone third-party software packages that can be installed on Home Assistant OS. [\\[Learn more\\]](https:\/\/www.home-assistant.io\/getting-started\/concepts-terminology\/#apps), if you have any installed\n\nEach of these components needs to be updated separately.\n\n### Updating the Home Assistant Operating System\nUpdates of the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. are independent of other updates. They do not trigger repair issues and are usually backward-compatible.\n\n#### Prerequisites\n- [Backup your installation](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups).\n  - Make sure the backup is stored on a [backup location](https:\/\/www.home-assistant.io\/common-tasks\/general\/#defining-backup-locations) outside of the device where Home Assistant is installed.\n    - For example, if Home Assistant is installed on [Home Assistant Green](https:\/\/www.home-assistant.io\/green), make sure it is stored on [Home Assistant Cloud](https:\/\/www.home-assistant.io\/common-tasks\/general\/#about-the-backup-storage-on-home-assistant-cloud) or another location.\n  - So that you can [restore from that backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#restoring-a-backup) in case there is an issue with the system.\n#### To update the Home Assistant Operating System\nUsing the UIUsing the CLI\n\n1. Open the **Settings** panel.\n2. On the top you will be presented with an update notification.\n   - Troubleshooting: If you do not see that notification:\n     - In the top right corner, select the three dots\n       menu and select **Check for updates**.\n     - Go to [**System** \\> **Updates**](https:\/\/my.home-assistant.io\/redirect\/updates).\n       - Select the update notification.\n       - Select the cogwheel\n         , then set **Visible** to active.\n3. Open the notification for the component you want to update.\n4. If you want to update the system first (recommended), enable the backup toggle.\n5. Select **Update**.\n6. Check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed.\n\n```\nha os update\n```\n*This updates to the latest version. If you want to update to a specific version instead, use `ha os update --version 15.2`.*\n\nAdvanced: changing the boot slot used during the update\n\n#### About boot slots used during the update\nThe Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. uses two boot slots. On first installation, boot slot A is used. After that, on each Operating System update, the other boot slot is updated and reboot is triggered. On that reboot, the system boots from the other boot slot (A ➝ B ➝ A,…). When booting fails, the system automatically uses the previous boot slot, so that it boots from the last working operating system.\n\n#### Changing the boot slot used\nYou can manually define that the previous boot slot is used. This can be useful in cases where the system boots but something still seems wrong. For example, when the device is no longer correctly detected or you see another issue that might be related to the latest update of the operating system.\n\n1. To check which boot slot is currently in use and what OS versions are installed in the individual slots, in the Home Assistant command line, enter the following command:\n   ```\n   ha os info\n   ```\n2. To change the boot slot, enter the following command:\n   - This will boot into the other (previous) OS version.\n   ```\n   ha os boot-slot other\n   ```\n\nAlternatively, if the Operating Systems runs on a platform that uses the GRUB bootloader, a boot menu is presented early in the boot. The alternative boot slot can be selected here, marking it active for future boots if the following boot attempt is successful.\n### Updating Home Assistant Core\n#### Prerequisites\n1. [Back up your installation](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups) and store the backup and the [backup emergency kit](https:\/\/www.home-assistant.io\/more-info\/backup-emergency-kit\/) somewhere safe.\n   - This ensures that you can [restore your installation from backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#restoring-a-backup) if needed.\n2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](https:\/\/www.home-assistant.io\/blog\/categories\/core\/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` \/ `CMD + f`) and search for **Backward-incompatible changes**.\n#### To update Home Assistant Core\nTo update Home Assistant Core, choose one of the following options.\n\nUsing the UIUsing the CLI\n\n1. Open your Home Assistant UI.\n2. Go to the **Settings** panel.\n3. On the top you will be presented with an update notification.\n\n- Troubleshooting: If you do not see that notification:\n  - In the top right corner, select the three dots\n    menu and select **Check for updates**.\n  - Go to [**System** \\> **Updates**](https:\/\/my.home-assistant.io\/redirect\/updates).\n    - Select the update notification.\n    - Select the cogwheel\n      , then set **Visible** to active.\n\n1. Open the notification for the component you want to update.\n2. If you want to backup the system first (recommended), enable the backup toggle.\n3. Select **Update**.\n4. After the update completed, check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed.\n\n```\nha core update --backup\n```\n*The* `--backup` *flag here ensures that you have a partial backup of your current setup in case you need to downgrade.*\n## Network storage\nYou can configure both Network File System (NFS) and Samba\/Windows (CIFS) targets to be used within Home Assistant and apps. To list all your currently connected network storages, go to **[Settings \\> System \\> Storage](https:\/\/my.home-assistant.io\/redirect\/storage)** in the UI.\n\nImportant\n\nYou need to update to Home Assistant Operating System 10.2 before you can use this feature.\n\n![](https:\/\/www.home-assistant.io\/images\/screenshots\/network-storage\/list_light.png) Screenshot of the list of network shares inside the storage panel.\n\n### Add a new network storage\n1. Go to **[Settings \\> System \\> Storage](https:\/\/my.home-assistant.io\/redirect\/storage)** in the UI.\n2. Select **Add network storage**.\n3. Fill out all the information for your network storage.\n4. Select **Connect**.\n\n![](https:\/\/www.home-assistant.io\/images\/screenshots\/network-storage\/connect_light.png) Screenshot of connecting a new network storage.\n\n#### Network storage configuration\nName\n\nThis is the name that will be used for the mounted directory on your system.\n\nUsage\n\nHere, you select how the target should be used. [See usage types below](https:\/\/www.home-assistant.io\/common-tasks\/os\/#usage-types)\n\nServer\n\nThe IP\/hostname of the server running NFS\/CIFS.\n\nProtocol3\n\nThe service the server is using for the network storage.\n\n\\[NFS\\]1 Remote share path\n\nThe path used to connect to the remote storage server.\n\n\\[CIFS\\]2 Username\n\nThe username to use when connecting to the storage server. Use User Principal Name for domain accounts. For example: `[email protected]`.\n\n\\[CIFS\\]2 Password\n\nThe password to use when connecting to the storage server.\n\n\\[CIFS\\]2 Share\n\nThe share to connect to on the storage server.\n\n1 *Options prefixed with `[NFS]` are only available for NFS targets.*  \n 2 *Options prefixed with `[CIFS]` are only available for CIFS targets.*  \n 3 *For the `CIFS` option, only version 2.1+ is supported.*\n\n##### Usage types\nBackup\n\nThis will become a target. You can use it when creating an automatic or manual backup. The first storage you add of this type becomes your new default target. If you want to change the default target, [check out the documentation below](https:\/\/www.home-assistant.io\/common-tasks\/os\/#change-default-local-backup-location).\n\nMedia\n\nA new directory with the name you gave your network storage will be created under `\/media`. This directory can be accessed by Home Assistant and apps.\n\nShare\n\nA new directory with the name you gave your network storage will be created under `\/share`. This directory can be accessed by Home Assistant and apps.\n### Change default local backup location\nBy default, the first network storage of type **Backup** that you add is used as your local default backup location.\n\nIf you want to change the local network storage that is used to store your backups, follow these steps:\n\n1. Go to **[Settings \\> System \\> Backups](https:\/\/my.home-assistant.io\/redirect\/backup)**.\n2. Select **Settings and history**.\n3. In the top-right corner, select the three dots\n   menu and select **Change default action location**.\n4. Select your preferred network location and save your changes. ![Select default location used for local backup](https:\/\/www.home-assistant.io\/images\/screenshots\/network-storage\/backup_select_local_default.png)\n5. Troubleshooting: Don’t see your external storage location? This list contains only the network storage targets you have added of type **Backup**.\n## Lost Password and password reset\nPlease refer to the [I’m locked out\\!](https:\/\/www.home-assistant.io\/docs\/locked_out\/) documentation page.\n\n## Installing a third-party app repository\nHome Assistant allows anyone to create an app repository to share their own apps with the community.\n\nWarning\n\nHome Assistant cannot guarantee the quality or security of third-party apps. Use at your own risk.\n\nTo add an app repository, follow these steps:\n\n1. Copy the URL of the repository.\n   - The URL is the git repository clone URL (on GitHub, use the Code button and copy the HTTPS URL).\n   - This documentation uses an example app repository. It is not practically useful but follows the same steps.\n   - If you are interested in app development, refer to our [Home Assistant app development documentation](https:\/\/developers.home-assistant.io\/docs\/apps\/).\n     ```\n     https:\/\/github.com\/home-assistant\/hassio-addons-example\n     ```\n2. Go to [**Settings** \\> **Apps**](https:\/\/my.home-assistant.io\/redirect\/supervisor) and select **App store**. ![Screenshot of the Home Assistant app store](https:\/\/www.home-assistant.io\/images\/getting-started\/app-store.png)\n3. In the top-right corner, select the three dots\n   menu, and select **Repositories**.\n4. Add the URL of the repository and select **Add**. ![Screenshot of the app store](https:\/\/www.home-assistant.io\/images\/getting-started\/adding_repositories-url.png)\n   - Result: A new card for the third-party repository will appear. ![Screenshot of the app store](https:\/\/www.home-assistant.io\/images\/getting-started\/add-ons-community_example.png)\n### Troubleshooting: Repository is not showing up\nIf you have added an app repository, but it’s not showing up, make sure to refresh your browser. If it still doesn’t show up, the app repository may contain invalid configuration data.\n\n1. Go to [**Settings** \\> **System** \\> **Logs**](https:\/\/my.home-assistant.io\/redirect\/logs) and select Supervisor in the top right corner to get the Supervisor log.\n   - It should tell you what went wrong.\n2. Report this information to the app repository author.\n## Configuration check\nAfter changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core.\n\n### Running a configuration check from the UI\n1. Go to [your user profile](https:\/\/my.home-assistant.io\/redirect\/profile) and enable **Advanced Mode**.\n2. Go to [**Settings** \\> **Developer tools** \\> **YAML**](https:\/\/my.home-assistant.io\/redirect\/server_controls) and in the **Configuration validation** section, select the **Check configuration** button.\n   - This is to make sure there are no syntax errors before restarting Home Assistant.\n   - It checks for valid YAMLYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the `configuration.yaml` or `automations.yaml` files. [\\[Learn more\\]](https:\/\/www.home-assistant.io\/docs\/configuration\/yaml\/) and valid config structures.\n3. If you need to do a more comprehensive configuration check, [run the check from the CLI](https:\/\/www.home-assistant.io\/common-tasks\/os\/#to-run-a-configuration-check-from-the-cli).\n### Running a configuration check from the CLI\nUse the following command to check if the configuration is valid. The command line configuration check validates the YAMLYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the `configuration.yaml` or `automations.yaml` files. [\\[Learn more\\]](https:\/\/www.home-assistant.io\/docs\/configuration\/yaml\/) files and checks for valid config structures, as well as some other elements.\n```\nha core check\n```\n## Home Assistant versions\nTo see which version your system is running, go to [**Settings** \\> **About**](https:\/\/my.home-assistant.io\/redirect\/info).\n\n### Feature preview\nIf you want to preview upcoming features, you can enable preview under [**Settings** \\> **System** \\> **Labs**](https:\/\/my.home-assistant.io\/redirect\/labs).\n\n**Labs** allows you to preview selected features that are stable but are still being fine-tuned. Preview is different from installing a beta or development version, which are used for development and testing.\n\nFor more information, refer to the [Labs documentation](https:\/\/www.home-assistant.io\/integrations\/labs).\n\n### Running a beta version\nIf you would like to test next release before anyone else, you can install the beta version.\n\nFrom the UIFrom the CLI\n\n1. In Home Assistant, go to [**System** \\> **Updates**](https:\/\/my.home-assistant.io\/redirect\/updates).\n2. In the top-right corner, select the three dots\n   menu.\n3. Select **Join beta**.\n4. Go to the [**Configuration**](https:\/\/my.home-assistant.io\/redirect\/configuration) panel.\n5. Install the update that is presented to you.\n   - Troubleshooting: If you do not see that notification:\n     - In the top right corner, select the three dots\n       menu and select **Check for updates**.\n     - Go to [**System** \\> **Updates**](https:\/\/my.home-assistant.io\/redirect\/updates).\n       - Select the update notification.\n       - Select the cogwheel\n         , then set **Visible** to active.\n\n1. Join the beta channel.\n   ```\n   ha supervisor options --channel beta\n   ```\n2. Reload Home Assistant Supervisor.\n   ```\n   ha supervisor reload\n   ```\n3. Update Home Assistant Core to the latest beta version.\n   ```\n   ha core update --backup\n   ```\n   *The* `--backup` *flag here ensures that you have a partial backup of your current setup in case you need to downgrade.*\n### Running a development version\nIf you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to `dev`.\n\nCaution\n\nThe `dev` branch is likely to be unstable. Potential consequences include loss of data and instance corruption.\n\n1. Join the dev channel.\n   ```\n   ha supervisor options --channel dev\n   ```\n2. Reload the Home Assistant SupervisorThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System..\n   ```\n   ha supervisor reload\n   ```\n3. Update Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated. to the latest dev version.\n   ```\n   ha core update --backup\n   ```\n   *The* `--backup` *flag here ensures that you have a partial backup of your current setup incase you need to downgrade.*\n### Running a specific version\nTo upgrade to a specific version, you can use the command line (CLI). The example below shows how to upgrade to `2026.4.1`. To learn how to get started with the command line in Home Assistant, refer to the [SSH app setup instructions](https:\/\/www.home-assistant.io\/common-tasks\/os\/#installing-and-using-the-ssh-app).\n```\nha core update --version 2026.4.1 --backup\n```\n*The* `--backup` *flag here ensures that you have a partial backup of your current setup in case you need to downgrade later.*\n\nTo downgrade your installation, do a [partial restore of a backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups) instead.\n\n## Using external data disk\nHome Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. supports storing data on a secondary storage medium. For example, this can be a second internal SSD or HDD or a USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster.\n\n![Graphics showing the architecture of the data disk feature](https:\/\/www.home-assistant.io\/images\/haos\/usb-data-disk.png)\n\nThe data disk feature can be used on an existing installation without losing data: The system will move existing data to the external data disk automatically. However, it is recommended to create and download a full [Backup](https:\/\/www.home-assistant.io\/common-tasks\/os\/#backups) before proceeding\\!\n\nCaution\n\nAll data on the target disk will be overwritten\\!\n\nImportant\n\nThe storage capacity of the external data disk must be larger than the storage capacity of the existing (boot) disk.\n\nImportant\n\nIf you have been using a data disk previously with Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., you need to use your host computer to delete all partitions *before* using it as a data disk again.\n### Using UI to move the data partition\n1. Connect the data disk to your system.\n2. Go to **[Settings \\> System \\> Storage](https:\/\/my.home-assistant.io\/redirect\/storage)** in the UI.\n3. Select **Move data disk**.\n4. Select the data disk from the list of available devices.\n5. Select **Move**.\n   - Depending on the amount of data, this may take a while.\n### Using CLI to move the data partition\nTo see the current data disk use:\n```\n$ ha os info\n...\ndata_disk: \/dev\/mmcblk1p4\n...\n```\nTo get a list of potential targets which can be used by `datadisk`:\n```\nha os datadisk list\n```\nTo initiate the move to the new data disk use the `move` command:\n```\nha os datadisk move \/dev\/sdx\n```\nThe system will prepare the data disk and immediately reboot. The reboot will take 10 minutes or more depending on the speed of the new data disk; please be patient\\!\n\nWarning\n\nUsing an USB attached SSD can draw quite some power. For instance on Raspberry Pi 3 the official Raspberry Pi power supply (PSU) only provides 2.5A which can be too tight. Use a more powerful power supply if you experience issues. Alternatively use a powered USB hub. Connect the Hub to one of the USB slots of your Raspberry Pi, and connect the SSD to the Hub. In this setup the power supply of the Hub will power the attached device(s).\n### Migrating an external data disk to another system\nThis section shows how to move an external data disk from one system to another. This can be an option if the following elements apply to your use case:\n\n- You already have a functioning Home Assistant instance (system 1) that is using an external data disk.\n- You have another, new, Home Assistant instance (system 2).\n- You now want to use the data disk of system 1 on system 2 instead.\n\nThe aim is to migrate the data from system 1 to system 2. One way to do this is by [restoring a backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#restoring-a-backup). The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk or if your external disk has more storage capacity than your new system.\n\n#### Prerequisites\n- A Home Assistant instance using an external data disk (system 1)\n- A Home Assistant instance to which you want to move the external data disk (system 2)\n#### To migrate an external data disk to another system\nTo migrate an external data disk from one system to another, follow these steps:\n\n1. [Create a backup](https:\/\/www.home-assistant.io\/common-tasks\/general\/#backups) of both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data).\n2. Shut down system 1 and remove the data disk.\n3. Make sure system 2 has Home Assistant OS installed, and Home Assistant is up and running. Home Assistant is using the data disk (partition) on the boot drive (e.g. SD card) at this point.\n4. Make sure system 2 has completed the basic [onboarding](https:\/\/www.home-assistant.io\/getting-started\/onboarding\/) steps, including the last steps where devices are discovered automatically.\n5. Plug the external disk into system 2 and go to the **Settings** \\> **System**. Select the three dots\n   menu, and **Restart Home Assistant** \\> **Reboot system**. Result: A repair issue is displayed **Multiple data disks detected**.\n   - The repair issue comes up because system 2 now sees two file systems with an identical name. During a reboot, there is a name conflict with the existing data disk as it is undefined which file system should be used. This can lead to a random selection of the system you end up with. Hence you must make a decision.\n6. Open the repair issue and choose one of the options:\n   - Select **Use the detected data disk instead of the current system**.\n     - This will override the current file system of system 2 and use your external data disk instead.\n     - You won’t have access anymore to the current Home Assistant data. It will be marked as inactive data disk.\n   - If you changed your mind about using the external data disk:\n     - Unplug the external data disk.\n     - If you cannot unplug the external data disk for some reason, select **Mark as inactive data disk (rename file system)**.\n       - This makes sure that there is no name conflict after rebooting.\n       - It also means you cannot use the file system that is stored on your external disk.\n       - You keep using the current file system of system 1.\n## Home Assistant via the command line\nOn the [SSH command line](https:\/\/www.home-assistant.io\/common-tasks\/os\/), you can use the `ha` command to retrieve logs, check the details of connected hardware, and more.\n\n### Home Assistant\n```\nha core check\nha core info\nha core logs\nha core options\nha core rebuild\nha core restart\nha core restart --safe-mode\nha core start\nha core stats\nha core stop\nha core update\n```\n### Supervisor\n```\nha supervisor info\nha supervisor logs\nha supervisor reload\nha supervisor update\n```\n### Host\n```\nha host reboot\nha host shutdown\nha host update\n```\n### Hardware\n```\nha hardware info\nha hardware audio\n```\n### Usage examples\nTo update Home Assistant to a specific version, use the command:\n```\nha core update --version x.y.z\n```\nReplace x.y.z with the desired version like `--version 2026.4.1`\n\nYou can get a better description of the CLI capabilities by typing `ha help`:\n```\nThe Home Assistant CLI is a small and simple command line utility that allows\nyou to control and configure different aspects of Home Assistant\n\nUsage:\n  ha [command]\n\nAvailable Commands:\n  addons         Install, update, remove and configure Home Assistant apps\n  audio          Audio device handling.\n  authentication Authentication for Home Assistant users.\n  backups        Create, restore and remove backups\n  banner         Prints the CLI Home Assistant banner along with some useful information\n  cli            Get information, update or configure the Home Assistant cli backend\n  core           Provides control of the Home Assistant Core\n  dns            Get information, update or configure the Home Assistant DNS server\n  docker         Docker backend specific for info and OCI configuration\n  hardware       Provides hardware information about your system\n  help           Help about any command\n  host           Control the host\/system that Home Assistant is running on\n  info           Provides a general Home Assistant information overview\n  jobs           Get information and manage running jobs\n  multicast      Get information, update or configure the Home Assistant Multicast\n  network        Network specific for updating, info and configuration imports\n  observer       Get information, update or configure the Home Assistant observer\n  os             Operating System specific for updating, info and configuration imports\n  resolution     Resolution center of Supervisor, show issues and suggest solutions\n  supervisor     Monitor, control and configure the Home Assistant Supervisor\n\nFlags:\n      --api-token string   Home Assistant Supervisor API token\n      --config string      Optional config file (default is $HOME\/.homeassistant.yaml)\n      --endpoint string    Endpoint for Home Assistant Supervisor (default is 'supervisor')\n  -h, --help               help for ha\n      --log-level string   Log level (defaults to Warn)\n      --no-progress        Disable the progress spinner\n      --raw-json           Output raw JSON from the API\n\nUse \"ha [command] --help\" for more information about a command.\n```\n### Console access\nYou can also access the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. via a directly connected keyboard and monitor, the console.\n\n#### Wiping the data disk from the command line\nIn Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., the `ha os datadisk wipe` command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed apps.\n\nThe command `ha os datadisk wipe` marks the data partition (either internal on the eMMC or the SD card, or on an external attached data disk) as to be cleared on the next reboot. The command automatically reboots the system. Upon reboot, the data is cleared. Then the system continues to boot and reinstalls the latest version of all Home Assistant components.\n\nThe `ha os datadisk wipe` command can only be run from the local terminal. Connect a display and keyboard and use the terminal.\n\nNote, some systems have a reset button you can use to clear the data disk, instead of using the command line:\n\n- If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 5, use the command line steps described above.\n- If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 4, there is a red hardware button to wipe the data disk. Follow the procedure on [resetting the Home Assistant Yellow](https:\/\/support.nabucasa.com\/hc\/articles\/25463622043165).\n- If you have a Home Assistant Green, there is a black hardware button to wipe the data disk. Follow the procedure on [resetting the Home Assistant Green](https:\/\/support.nabucasa.com\/hc\/en-us\/articles\/25161225495837).\n#### Listing all users from the command line\nIn Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., the `ha auth list` command lists all users that are registered on your Home Assistant.\n\nThe `ha auth list` command can only be run from the local terminal. Connect a display and keyboard and use the terminal.\n\n## Enable duplicate log file\nBy default, Home Assistant Core logs are sent to the Systemd Journal, which can be read using the [`ha core logs` command](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-via-the-command-line). If you need logs to also be written to a file (`\/config\/home-assistant.log`), you can enable the duplicated log file option using the [command line](https:\/\/www.home-assistant.io\/common-tasks\/os\/#home-assistant-via-the-command-line):\n```\nha core options --duplicate-log-file=true\nha core rebuild\nha core restart\n```\nTo disable it:\n```\nha core options --duplicate-log-file=false\nha core rebuild\nha core restart\n```\n## Enable I2C\nHome Assistant using the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. which is a managed environment, which means you can’t use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to\n\n- Enable I2C for the Home Assistant Operating System\n- Setup I2C devices e.g. sensors\n### Enable I2C with an SD card reader\n#### Access the boot partition\nYou will need:\n\n- SD card reader\n- SD card with Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. flashed on it\n\nShutdown\/turn-off your Home Assistant installation and unplug the SD card. Plug the SD card into an SD card reader and find a drive\/file system named `hassos-boot`. The file system might be shown\/mounted automatically. If not, use your operating systems disk management utility to find the SD card reader and make sure the first partition is available.\n\n#### Add files to enable I2C\n- In the root of the `hassos-boot` partition, add a new folder called `CONFIG`.\n- In the `CONFIG` folder, add another new folder called `modules`.\n- Inside the `modules` folder add a text file called `rpi-i2c.conf` with the following content:\n  ```\n  i2c-dev\n  ```\n- In the root of the `hassos-boot` partition, edit the file called `config.txt` add two lines to it:\n  ```\n  dtparam=i2c_vc=on\ndtparam=i2c_arm=on\n  ```\n#### Start with the new OS configuration\n- Insert the SD card back into your Raspberry Pi.\n- On startup, the `hassos-config.service` will automatically pickup the new `rpi-i2c.conf` configuration.\n- Another reboot might be necessary to make sure the just imported `rpi-i2c.conf` is present at boot time.\n### Enable I2C via Home Assistant Operating System Terminal\nAlternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users..\n\nYou can enable I2C via this terminal:\n\n- Login as `root`.\n- Type `login` and press enter to access the shell:\n  ```\n  mkdir -p \/mnt\/boot\/CONFIG\/modules\necho i2c-dev > \/mnt\/boot\/CONFIG\/modules\/rpi-i2c.conf\necho dtparam=i2c_vc=on >> \/mnt\/boot\/config.txt\necho dtparam=i2c_arm=on >> \/mnt\/boot\/config.txt\nsync\nreboot\n  ```\n### Troubleshooting\nAfter rebooting the host there should be `i2c-0` and similar device files in `\/dev`. If such device files are missing, enabling I2C failed for some reason. You can check the status of I2C kernel modules by using `lsmod | grep i2c` in the terminal. If they are loaded, you should find at least the entry `i2c_dev`. Active usage of the modules is indicated by a number, e.g. `i2c_dev 20480 2` would indicate two active I2C device files.\n\nAn active I2C can also be checked with a multi meter showing 3.3 V on the I2C pins GPIO2 and GPIO3.\n\n#### **Help us improve our documentation**\nSuggest an edit to this page, or provide\/view feedback for this page.\n\n- [Edit](https:\/\/github.com\/home-assistant\/home-assistant.io\/tree\/current\/source\/common-tasks\/os.markdown \"Edit this page\")\n- [Provide feedback](https:\/\/github.com\/home-assistant\/home-assistant.io\/issues\/new?template=feedback.yml&url=https%3A%2F%2Fwww.home-assistant.io%2Fcommon-tasks%2Fos%2F&version=2026.4.1&labels=current \"Provide feedback on this page\")\n- [View given feedback](https:\/\/github.com\/home-assistant\/home-assistant.io\/issues?utf8=%E2%9C%93&q=%22%2Fcommon-tasks%2Fos%2F%22&in=body \"View given feedback for this page\")","meta_canonical":null}

3. Robots.txt Check

Query:

Response:

4. Spam/Ban Check

Query:

Response:

5. Seen Status Check

ℹ️ Skipped - page is already crawled

📄

INDEXABLE

✅

CRAWLED

3 hours ago

🤖

ROBOTS ALLOWED

Page Info Filters

Filter	Status	Condition	Details
HTTP status	PASS	`download_http_code = 200`	HTTP 200
Age cutoff	PASS	`download_stamp > now() - 6 MONTH`	0 months ago
History drop	PASS	`isNull(history_drop_reason)`	No drop reason
Spam/ban	PASS	`fh_dont_index != 1 AND ml_spam_score = 0`	ml_spam_score=0
Canonical	PASS	`meta_canonical IS NULL OR = '' OR = src_unparsed`	Not set

Page Details

Property	Value
URL	https://www.home-assistant.io/common-tasks/os/
Last Crawled	2026-04-08 18:02:26 (3 hours ago)
First Indexed	2021-02-11 20:50:58 (5 years ago)
HTTP Status Code	200
Meta Title	Common tasks - Operating System - Home Assistant
Meta Description	Common tasks for Home Assistant Operating System
Meta Canonical	null
Boilerpipe Text	This section will provide guides to some common tasks and information which you will need in order to run, maintain, and edit your Home Assistant OS system. For further details on any particular subject, make sure to refer to the documentation for specific apps (formerly known as add-ons) or topics listed here. Configuring access to files Your Home Assistant Operating server includes two repositories by default: The official core app repository, and the community app repository. All of the apps mentioned here can be installed by navigating to the app store using Settings > Apps > Install app in the UI. One of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several apps commonly used for this, and most users employ a mix of various apps. Default directories on the host are mapped to the apps so that they can be accessed by the services any particular app might provide. On the host system these directories exist on the /data partition at /mnt/data/supervisor/ . Using any of the apps listed below, the following directories are made available for access: addons backup config media share ssl Installing and using the Samba app The Samba app allows you to share the directories on Home Assistant with other systems on your network. After installing the app, you can then also edit files using the editor of your preference from your client computer. This app can be installed from the app store’s official repository. To install the app, follow these steps: Go to Settings > Apps > Samba share and select Install . On the Configuration tab, define Username and Password , store them in a safe place, and save your changes. You can specify any username and password. They are not related to the login credentials you use to log in to Home Assistant or to log in to the computer from which you are accessing the files. The app won’t start if username and password are not defined. For further configuration information, refer to the Documentation tab. To start the app, on the Information tab, select Start . To access the Home Assistant directories from the other device, follow these steps: Go to Settings > System > Network and take note of the Host name . Alternatively, you can look up the host name or IP address of your Home Assistant on your router. How you connect from another device to Home Assistant depends on your system. Use one of the following options: On Windows : Open File Explorer and in the address bar, enter the IP address or hostname with two backslashes as \\your.ha.ip.address or \\hostname . Screenshot of File Explorer displaying the navigation to a file share using an IP address On OS X : Open Finder and select Go > Connect to Server… and enter the IP address or hostname as smb://your.ha.ip.address or smb://hostname . On Ubuntu : Open Files and in the address bar, enter the IP address or hostname as smb://your.ha.ip.address or smb://hostname . Enter the credentials you entered in the Samba app configuration. You also have the option of having the credentials stored so that you do not need to enter them again. Done! You now have access to the directories which you can then mount as a drive or pin to Quick Access. Installing and using the Visual Studio Code (VSC) app The Studio Code Server app provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64/ARM64 machines. The app also provides access to the Home Assistant Command Line Interface (CLI) using VSC’s built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and apps, creating/restoring backups, and more. (See Home Assistant via Command Line for further info). Example of a configuration.yaml file, accessed using the Studio Code Server app on a Home Assistant Operating System installation. To install and use the Studio Code Server in Home Assistant, follow these steps: To install the app, go to Settings > Apps > Studio Code Server and install the app. Once you have the app installed, if you want, select the Show in sidebar option. Then, select Start . For information on configuration settings, open the Documentation tab. To start browsing, on the Info tab, select Open Web UI . Installing and using the File Editor app The File Editor app is a web-based file system browser and text editor. It is a more basic and light weight alternative to Visual Studio Code. YAML files are automatically checked for syntax errors while editing. Example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation. To install and use the File Editor in Home Assistant, follow these steps: To install the app, go to Settings > Apps > File editor . Once you have the app installed, you can edit files within your /config directory. If you want to be able to access directories outside the /config directory, you need to disable an option in the app configuration. Go to the app under Settings > Apps > File editor . Open the Configuration tab. In the configuration settings, disable the Enforce basepath option. Note: The Enforce basepath option is intended to protect you from inadvertently making changes to settings files. For information on other configuration settings, open the Documentation tab. To confirm your changes, select Save . To start browsing, on the Info tab, select Open Web UI . Installing and using the SSH app If you want to use the Home Assistant command line or an SSH client, you can do this through the Terminal & SSH app. The Terminal & SSH app provides the following functionalities: It provides a web terminal that you can access from the Home Assistant user interface. It allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and apps, creating/restoring backups, and more. For a list of command line commands, refer to Home Assistant via Command Line . It allows connecting to your system using an SSH client. It also includes common tools like nano and vi editors. The Terminal & SSH app does not provide access to the underlying host file system. To get started with the Terminal & SSH app, follow these steps: In the bottom left, select your user to open the Profile page. Make sure Advanced Mode is enabled. To install the app, go to the app store under Settings > Apps and install the Terminal & SSH app. To use the web terminal, start the app, then select Open Web UI . You can now start typing your commands . If you want to access from an ssh client, you need to enter credentials: Open the Configuration page. Enter a password or authorized Keys. Then save and start the app. Backup To learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under common tasks . Alternative: Creating a backup using the Home Assistant Command Line Interface In general, to create or restore from a backup, follow the steps described under common tasks . However, If you have the Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you can also create a backup from the command line. Follow these steps: ha backups list - lists backups and their slugnames ha backups restore slugname - restores a specific backup ha backups new --name nameofbackup - create a backup For additional information about command line usage, use the ha help command or refer to the Home Assistant Command Line documentation . Updating Home Assistant If you have the Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you receive update notifications from different components: Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. Home Assistant Supervisor The Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System. Home Assistant Core Home Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated. Apps Apps are additional standalone third-party software packages that can be installed on Home Assistant OS. [Learn more] , if you have any installed Each of these components needs to be updated separately. Updating the Home Assistant Operating System Updates of the Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. are independent of other updates. They do not trigger repair issues and are usually backward-compatible. Prerequisites Backup your installation . Make sure the backup is stored on a backup location outside of the device where Home Assistant is installed. For example, if Home Assistant is installed on Home Assistant Green , make sure it is stored on Home Assistant Cloud or another location. So that you can restore from that backup in case there is an issue with the system. To update the Home Assistant Operating System Using the UI Using the CLI Open the Settings panel. On the top you will be presented with an update notification. Troubleshooting: If you do not see that notification: In the top right corner, select the three dots menu and select Check for updates . Go to System > Updates . Select the update notification. Select the cogwheel , then set Visible to active. Open the notification for the component you want to update. If you want to update the system first (recommended), enable the backup toggle. Select Update . Check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed. ha os update This updates to the latest version. If you want to update to a specific version instead, use ha os update --version 15.2 . Advanced: changing the boot slot used during the update About boot slots used during the update The Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. uses two boot slots. On first installation, boot slot A is used. After that, on each Operating System update, the other boot slot is updated and reboot is triggered. On that reboot, the system boots from the other boot slot (A ➝ B ➝ A,…). When booting fails, the system automatically uses the previous boot slot, so that it boots from the last working operating system. Changing the boot slot used You can manually define that the previous boot slot is used. This can be useful in cases where the system boots but something still seems wrong. For example, when the device is no longer correctly detected or you see another issue that might be related to the latest update of the operating system. To check which boot slot is currently in use and what OS versions are installed in the individual slots, in the Home Assistant command line, enter the following command: ha os info To change the boot slot, enter the following command: This will boot into the other (previous) OS version. ha os boot-slot other Alternatively, if the Operating Systems runs on a platform that uses the GRUB bootloader, a boot menu is presented early in the boot. The alternative boot slot can be selected here, marking it active for future boots if the following boot attempt is successful. Updating Home Assistant Core Prerequisites Back up your installation and store the backup and the backup emergency kit somewhere safe. This ensures that you can restore your installation from backup if needed. Check the release notes for backward-incompatible changes on Home Assistant release notes . Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser ( CTRL + f / CMD + f ) and search for Backward-incompatible changes . To update Home Assistant Core To update Home Assistant Core, choose one of the following options. Using the UI Using the CLI Open your Home Assistant UI. Go to the Settings panel. On the top you will be presented with an update notification. Troubleshooting: If you do not see that notification: In the top right corner, select the three dots menu and select Check for updates . Go to System > Updates . Select the update notification. Select the cogwheel , then set Visible to active. Open the notification for the component you want to update. If you want to backup the system first (recommended), enable the backup toggle. Select Update . After the update completed, check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed. ha core update --backup The --backup flag here ensures that you have a partial backup of your current setup in case you need to downgrade. Network storage You can configure both Network File System (NFS) and Samba/Windows (CIFS) targets to be used within Home Assistant and apps. To list all your currently connected network storages, go to Settings > System > Storage in the UI. Important You need to update to Home Assistant Operating System 10.2 before you can use this feature. Screenshot of the list of network shares inside the storage panel. Add a new network storage Go to Settings > System > Storage in the UI. Select Add network storage . Fill out all the information for your network storage. Select Connect . Screenshot of connecting a new network storage. Network storage configuration Name This is the name that will be used for the mounted directory on your system. Usage Here, you select how the target should be used. See usage types below Server The IP/hostname of the server running NFS/CIFS. Protocol 3 The service the server is using for the network storage. [NFS] 1 Remote share path The path used to connect to the remote storage server. [CIFS] 2 Username The username to use when connecting to the storage server. Use User Principal Name for domain accounts. For example: [email protected] . [CIFS] 2 Password The password to use when connecting to the storage server. [CIFS] 2 Share The share to connect to on the storage server. 1 Options prefixed with [NFS] are only available for NFS targets. 2 Options prefixed with [CIFS] are only available for CIFS targets. 3 For the CIFS option, only version 2.1+ is supported. Usage types Backup This will become a target. You can use it when creating an automatic or manual backup. The first storage you add of this type becomes your new default target. If you want to change the default target, check out the documentation below . Media A new directory with the name you gave your network storage will be created under /media . This directory can be accessed by Home Assistant and apps. Share A new directory with the name you gave your network storage will be created under /share . This directory can be accessed by Home Assistant and apps. Change default local backup location By default, the first network storage of type Backup that you add is used as your local default backup location. If you want to change the local network storage that is used to store your backups, follow these steps: Go to Settings > System > Backups . Select Settings and history . In the top-right corner, select the three dots menu and select Change default action location . Select your preferred network location and save your changes. Troubleshooting: Don’t see your external storage location? This list contains only the network storage targets you have added of type Backup . Lost Password and password reset Please refer to the I’m locked out! documentation page. Installing a third-party app repository Home Assistant allows anyone to create an app repository to share their own apps with the community. Warning Home Assistant cannot guarantee the quality or security of third-party apps. Use at your own risk. To add an app repository, follow these steps: Copy the URL of the repository. The URL is the git repository clone URL (on GitHub, use the Code button and copy the HTTPS URL). This documentation uses an example app repository. It is not practically useful but follows the same steps. If you are interested in app development, refer to our Home Assistant app development documentation . https://github.com/home-assistant/hassio-addons-example Go to Settings > Apps and select App store . In the top-right corner, select the three dots menu, and select Repositories . Add the URL of the repository and select Add . Result: A new card for the third-party repository will appear. Troubleshooting: Repository is not showing up If you have added an app repository, but it’s not showing up, make sure to refresh your browser. If it still doesn’t show up, the app repository may contain invalid configuration data. Go to Settings > System > Logs and select Supervisor in the top right corner to get the Supervisor log. It should tell you what went wrong. Report this information to the app repository author. Configuration check After changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core. Running a configuration check from the UI Go to your user profile and enable Advanced Mode . Go to Settings > Developer tools > YAML and in the Configuration validation section, select the Check configuration button. This is to make sure there are no syntax errors before restarting Home Assistant. It checks for valid YAML YAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the configuration.yaml or automations.yaml files. [Learn more] and valid config structures. If you need to do a more comprehensive configuration check, run the check from the CLI . Running a configuration check from the CLI Use the following command to check if the configuration is valid. The command line configuration check validates the YAML YAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the configuration.yaml or automations.yaml files. [Learn more] files and checks for valid config structures, as well as some other elements. ha core check Home Assistant versions To see which version your system is running, go to Settings > About . Feature preview If you want to preview upcoming features, you can enable preview under Settings > System > Labs . Labs allows you to preview selected features that are stable but are still being fine-tuned. Preview is different from installing a beta or development version, which are used for development and testing. For more information, refer to the Labs documentation . Running a beta version If you would like to test next release before anyone else, you can install the beta version. From the UI From the CLI In Home Assistant, go to System > Updates . In the top-right corner, select the three dots menu. Select Join beta . Go to the Configuration panel. Install the update that is presented to you. Troubleshooting: If you do not see that notification: In the top right corner, select the three dots menu and select Check for updates . Go to System > Updates . Select the update notification. Select the cogwheel , then set Visible to active. Join the beta channel. ha supervisor options --channel beta Reload Home Assistant Supervisor. ha supervisor reload Update Home Assistant Core to the latest beta version. ha core update --backup The --backup flag here ensures that you have a partial backup of your current setup in case you need to downgrade. Running a development version If you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to dev . Caution The dev branch is likely to be unstable. Potential consequences include loss of data and instance corruption. Join the dev channel. ha supervisor options --channel dev Reload the Home Assistant Supervisor The Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System. . ha supervisor reload Update Home Assistant Core Home Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated. to the latest dev version. ha core update --backup The --backup flag here ensures that you have a partial backup of your current setup incase you need to downgrade. Running a specific version To upgrade to a specific version, you can use the command line (CLI). The example below shows how to upgrade to 2026.4.1 . To learn how to get started with the command line in Home Assistant, refer to the SSH app setup instructions . ha core update --version 2026.4.1 --backup The --backup flag here ensures that you have a partial backup of your current setup in case you need to downgrade later. To downgrade your installation, do a partial restore of a backup instead. Using external data disk Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. supports storing data on a secondary storage medium. For example, this can be a second internal SSD or HDD or a USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster. The data disk feature can be used on an existing installation without losing data: The system will move existing data to the external data disk automatically. However, it is recommended to create and download a full Backup before proceeding! Caution All data on the target disk will be overwritten! Important The storage capacity of the external data disk must be larger than the storage capacity of the existing (boot) disk. Important If you have been using a data disk previously with Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. , you need to use your host computer to delete all partitions before using it as a data disk again. Using UI to move the data partition Connect the data disk to your system. Go to Settings > System > Storage in the UI. Select Move data disk . Select the data disk from the list of available devices. Select Move . Depending on the amount of data, this may take a while. Using CLI to move the data partition To see the current data disk use: $ ha os info ... data_disk: /dev/mmcblk1p4 ... To get a list of potential targets which can be used by datadisk : ha os datadisk list To initiate the move to the new data disk use the move command: ha os datadisk move /dev/sdx The system will prepare the data disk and immediately reboot. The reboot will take 10 minutes or more depending on the speed of the new data disk; please be patient! Warning Using an USB attached SSD can draw quite some power. For instance on Raspberry Pi 3 the official Raspberry Pi power supply (PSU) only provides 2.5A which can be too tight. Use a more powerful power supply if you experience issues. Alternatively use a powered USB hub. Connect the Hub to one of the USB slots of your Raspberry Pi, and connect the SSD to the Hub. In this setup the power supply of the Hub will power the attached device(s). Migrating an external data disk to another system This section shows how to move an external data disk from one system to another. This can be an option if the following elements apply to your use case: You already have a functioning Home Assistant instance (system 1) that is using an external data disk. You have another, new, Home Assistant instance (system 2). You now want to use the data disk of system 1 on system 2 instead. The aim is to migrate the data from system 1 to system 2. One way to do this is by restoring a backup . The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk or if your external disk has more storage capacity than your new system. Prerequisites A Home Assistant instance using an external data disk (system 1) A Home Assistant instance to which you want to move the external data disk (system 2) To migrate an external data disk to another system To migrate an external data disk from one system to another, follow these steps: Create a backup of both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data). Shut down system 1 and remove the data disk. Make sure system 2 has Home Assistant OS installed, and Home Assistant is up and running. Home Assistant is using the data disk (partition) on the boot drive (e.g. SD card) at this point. Make sure system 2 has completed the basic onboarding steps, including the last steps where devices are discovered automatically. Plug the external disk into system 2 and go to the Settings > System . Select the three dots menu, and Restart Home Assistant > Reboot system . Result: A repair issue is displayed Multiple data disks detected . The repair issue comes up because system 2 now sees two file systems with an identical name. During a reboot, there is a name conflict with the existing data disk as it is undefined which file system should be used. This can lead to a random selection of the system you end up with. Hence you must make a decision. Open the repair issue and choose one of the options: Select Use the detected data disk instead of the current system . This will override the current file system of system 2 and use your external data disk instead. You won’t have access anymore to the current Home Assistant data. It will be marked as inactive data disk. If you changed your mind about using the external data disk: Unplug the external data disk. If you cannot unplug the external data disk for some reason, select Mark as inactive data disk (rename file system) . This makes sure that there is no name conflict after rebooting. It also means you cannot use the file system that is stored on your external disk. You keep using the current file system of system 1. Home Assistant via the command line On the SSH command line , you can use the ha command to retrieve logs, check the details of connected hardware, and more. Home Assistant ha core check ha core info ha core logs ha core options ha core rebuild ha core restart ha core restart --safe-mode ha core start ha core stats ha core stop ha core update Supervisor ha supervisor info ha supervisor logs ha supervisor reload ha supervisor update Host ha host reboot ha host shutdown ha host update Hardware ha hardware info ha hardware audio Usage examples To update Home Assistant to a specific version, use the command: ha core update --version x.y.z Replace x.y.z with the desired version like --version 2026.4.1 You can get a better description of the CLI capabilities by typing ha help : The Home Assistant CLI is a small and simple command line utility that allows you to control and configure different aspects of Home Assistant Usage: ha [command] Available Commands: addons Install, update, remove and configure Home Assistant apps audio Audio device handling. authentication Authentication for Home Assistant users. backups Create, restore and remove backups banner Prints the CLI Home Assistant banner along with some useful information cli Get information, update or configure the Home Assistant cli backend core Provides control of the Home Assistant Core dns Get information, update or configure the Home Assistant DNS server docker Docker backend specific for info and OCI configuration hardware Provides hardware information about your system help Help about any command host Control the host/system that Home Assistant is running on info Provides a general Home Assistant information overview jobs Get information and manage running jobs multicast Get information, update or configure the Home Assistant Multicast network Network specific for updating, info and configuration imports observer Get information, update or configure the Home Assistant observer os Operating System specific for updating, info and configuration imports resolution Resolution center of Supervisor, show issues and suggest solutions supervisor Monitor, control and configure the Home Assistant Supervisor Flags: --api-token string Home Assistant Supervisor API token --config string Optional config file (default is $HOME/.homeassistant.yaml) --endpoint string Endpoint for Home Assistant Supervisor (default is 'supervisor') -h, --help help for ha --log-level string Log level (defaults to Warn) --no-progress Disable the progress spinner --raw-json Output raw JSON from the API Use "ha [command] --help" for more information about a command. Console access You can also access the Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. via a directly connected keyboard and monitor, the console. Wiping the data disk from the command line In Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. , the ha os datadisk wipe command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed apps. The command ha os datadisk wipe marks the data partition (either internal on the eMMC or the SD card, or on an external attached data disk) as to be cleared on the next reboot. The command automatically reboots the system. Upon reboot, the data is cleared. Then the system continues to boot and reinstalls the latest version of all Home Assistant components. The ha os datadisk wipe command can only be run from the local terminal. Connect a display and keyboard and use the terminal. Note, some systems have a reset button you can use to clear the data disk, instead of using the command line: If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 5, use the command line steps described above. If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 4, there is a red hardware button to wipe the data disk. Follow the procedure on resetting the Home Assistant Yellow . If you have a Home Assistant Green, there is a black hardware button to wipe the data disk. Follow the procedure on resetting the Home Assistant Green . Listing all users from the command line In Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. , the ha auth list command lists all users that are registered on your Home Assistant. The ha auth list command can only be run from the local terminal. Connect a display and keyboard and use the terminal. Enable duplicate log file By default, Home Assistant Core logs are sent to the Systemd Journal, which can be read using the ha core logs command . If you need logs to also be written to a file ( /config/home-assistant.log ), you can enable the duplicated log file option using the command line : ha core options --duplicate-log-file = true ha core rebuild ha core restart To disable it: ha core options --duplicate-log-file = false ha core rebuild ha core restart Enable I2C Home Assistant using the Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. which is a managed environment, which means you can’t use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to Enable I2C for the Home Assistant Operating System Setup I2C devices e.g. sensors Enable I2C with an SD card reader Access the boot partition You will need: SD card reader SD card with Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. flashed on it Shutdown/turn-off your Home Assistant installation and unplug the SD card. Plug the SD card into an SD card reader and find a drive/file system named hassos-boot . The file system might be shown/mounted automatically. If not, use your operating systems disk management utility to find the SD card reader and make sure the first partition is available. Add files to enable I2C In the root of the hassos-boot partition, add a new folder called CONFIG . In the CONFIG folder, add another new folder called modules . Inside the modules folder add a text file called rpi-i2c.conf with the following content: i2c-dev In the root of the hassos-boot partition, edit the file called config.txt add two lines to it: dtparam=i2c_vc=on dtparam=i2c_arm=on Start with the new OS configuration Insert the SD card back into your Raspberry Pi. On startup, the hassos-config.service will automatically pickup the new rpi-i2c.conf configuration. Another reboot might be necessary to make sure the just imported rpi-i2c.conf is present at boot time. Enable I2C via Home Assistant Operating System Terminal Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the Home Assistant Operating System Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. . You can enable I2C via this terminal: Login as root . Type login and press enter to access the shell: mkdir -p /mnt/boot/CONFIG/modules echo i2c-dev > /mnt/boot/CONFIG/modules/rpi-i2c.conf echo dtparam = i2c_vc = on >> /mnt/boot/config.txt echo dtparam = i2c_arm = on >> /mnt/boot/config.txt sync reboot Troubleshooting After rebooting the host there should be i2c-0 and similar device files in /dev . If such device files are missing, enabling I2C failed for some reason. You can check the status of I2C kernel modules by using lsmod \| grep i2c in the terminal. If they are loaded, you should find at least the entry i2c_dev . Active usage of the modules is indicated by a number, e.g. i2c_dev 20480 2 would indicate two active I2C device files. An active I2C can also be checked with a multi meter showing 3.3 V on the I2C pins GPIO2 and GPIO3. Help us improve our documentation Suggest an edit to this page, or provide/view feedback for this page. Edit Provide feedback View given feedback
Markdown	[2026\.4.1](https://www.home-assistant.io/blog/2026/04/01/release-20264/ "Latest version 2026.4.1 released April 3, 2026") - [Getting started](https://www.home-assistant.io/installation/) - [Documentation](https://www.home-assistant.io/docs/) - [Installation](https://www.home-assistant.io/installation/) - [Automations](https://www.home-assistant.io/docs/automation/) - [Dashboards](https://www.home-assistant.io/dashboards/) - [Voice assistants](https://www.home-assistant.io/voice_control/) - [Device organization](https://www.home-assistant.io/docs/organizing/) - [Energy management](https://www.home-assistant.io/docs/energy/) - [Templating](https://www.home-assistant.io/docs/templating/) - [Advanced configuration](https://www.home-assistant.io/docs/configuration/) - [Our hardware](https://www.home-assistant.io/common-tasks/os/) - [Home Assistant Green](https://www.home-assistant.io/green/) - [Connect ZBT-2](https://www.home-assistant.io/connect/zbt-2/) - [Connect ZWA-2](https://www.home-assistant.io/connect/zwa-2/) - [Voice Preview Edition](https://www.home-assistant.io/voice-pe/) - [Integrations](https://www.home-assistant.io/integrations/) - [Blog](https://www.home-assistant.io/blog/) - [Need help?](https://www.home-assistant.io/help/) On this page - [Configuring access to files](https://www.home-assistant.io/common-tasks/os/#configuring-access-to-files) - [Installing and using the Samba app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-samba-app) - [Installing and using the Visual Studio Code (VSC) app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-app) - [Installing and using the File Editor app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-file-editor-app) - [Installing and using the SSH app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-ssh-app) - [Backup](https://www.home-assistant.io/common-tasks/os/#backup) - [Alternative: Creating a backup using the Home Assistant Command Line Interface](https://www.home-assistant.io/common-tasks/os/#alternative-creating-a-backup-using-the-home-assistant-command-line-interface) - [Updating Home Assistant](https://www.home-assistant.io/common-tasks/os/#updating-home-assistant) - [Updating the Home Assistant Operating System](https://www.home-assistant.io/common-tasks/os/#updating-the-home-assistant-operating-system) - [Updating Home Assistant Core](https://www.home-assistant.io/common-tasks/os/#updating-home-assistant-core) - [Network storage](https://www.home-assistant.io/common-tasks/os/#network-storage) - [Add a new network storage](https://www.home-assistant.io/common-tasks/os/#add-a-new-network-storage) - [Change default local backup location](https://www.home-assistant.io/common-tasks/os/#change-default-local-backup-location) - [Lost Password and password reset](https://www.home-assistant.io/common-tasks/os/#lost-password-and-password-reset) - [Installing a third-party app repository](https://www.home-assistant.io/common-tasks/os/#installing-a-third-party-app-repository) - [Troubleshooting: Repository is not showing up](https://www.home-assistant.io/common-tasks/os/#troubleshooting-repository-is-not-showing-up) - [Configuration check](https://www.home-assistant.io/common-tasks/os/#configuration-check) - [Running a configuration check from the UI](https://www.home-assistant.io/common-tasks/os/#running-a-configuration-check-from-the-ui) - [Running a configuration check from the CLI](https://www.home-assistant.io/common-tasks/os/#running-a-configuration-check-from-the-cli) - [Home Assistant versions](https://www.home-assistant.io/common-tasks/os/#home-assistant-versions) - [Feature preview](https://www.home-assistant.io/common-tasks/os/#feature-preview) - [Running a beta version](https://www.home-assistant.io/common-tasks/os/#running-a-beta-version) - [Running a development version](https://www.home-assistant.io/common-tasks/os/#running-a-development-version) - [Running a specific version](https://www.home-assistant.io/common-tasks/os/#running-a-specific-version) - [Using external data disk](https://www.home-assistant.io/common-tasks/os/#using-external-data-disk) - [Using UI to move the data partition](https://www.home-assistant.io/common-tasks/os/#using-ui-to-move-the-data-partition) - [Using CLI to move the data partition](https://www.home-assistant.io/common-tasks/os/#using-cli-to-move-the-data-partition) - [Migrating an external data disk to another system](https://www.home-assistant.io/common-tasks/os/#migrating-an-external-data-disk-to-another-system) - [Home Assistant via the command line](https://www.home-assistant.io/common-tasks/os/#home-assistant-via-the-command-line) - [Home Assistant](https://www.home-assistant.io/common-tasks/os/#home-assistant) - [Supervisor](https://www.home-assistant.io/common-tasks/os/#supervisor) - [Host](https://www.home-assistant.io/common-tasks/os/#host) - [Hardware](https://www.home-assistant.io/common-tasks/os/#hardware) - [Usage examples](https://www.home-assistant.io/common-tasks/os/#usage-examples) - [Console access](https://www.home-assistant.io/common-tasks/os/#console-access) - [Enable duplicate log file](https://www.home-assistant.io/common-tasks/os/#enable-duplicate-log-file) - [Enable I2C](https://www.home-assistant.io/common-tasks/os/#enable-i2c) - [Enable I2C with an SD card reader](https://www.home-assistant.io/common-tasks/os/#enable-i2c-with-an-sd-card-reader) - [Enable I2C via Home Assistant Operating System Terminal](https://www.home-assistant.io/common-tasks/os/#enable-i2c-via-home-assistant-operating-system-terminal) - [Troubleshooting](https://www.home-assistant.io/common-tasks/os/#troubleshooting) - [Related topics](https://www.home-assistant.io/common-tasks/os/#related-topics) [Home](https://www.home-assistant.io/) ▸ [Common tasks](https://www.home-assistant.io/common-tasks/) # Common tasks - Operating System This section will provide guides to some common tasks and information which you will need in order to run, maintain, and edit your Home Assistant OS system. For further details on any particular subject, make sure to refer to the documentation for specific apps (formerly known as add-ons) or topics listed here. ## Configuring access to files Your Home Assistant Operating server includes two repositories by default: The official core app repository, and the community app repository. All of the apps mentioned here can be installed by navigating to the app store using [Settings \> Apps \> Install app](https://my.home-assistant.io/redirect/supervisor_store) in the UI. One of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several apps commonly used for this, and most users employ a mix of various apps. Default directories on the host are mapped to the apps so that they can be accessed by the services any particular app might provide. On the host system these directories exist on the `/data` partition at `/mnt/data/supervisor/`. Using any of the apps listed below, the following directories are made available for access: - `addons` - `backup` - `config` - `media` - `share` - `ssl` * ### Installing and using the Samba app The Samba app allows you to share the directories on Home Assistant with other systems on your network. After installing the app, you can then also edit files using the editor of your preference from your client computer. This app can be installed from the app store’s official repository. To install the app, follow these steps: 1. Go to [Settings \> Apps \> Samba share](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_samba) and select Install. 2. On the Configuration tab, define Username and Password, store them in a safe place, and save your changes. - You can specify any username and password. - They are not related to the login credentials you use to log in to Home Assistant or to log in to the computer from which you are accessing the files. - The app won’t start if username and password are not defined. 3. For further configuration information, refer to the Documentation tab. 4. To start the app, on the Information tab, select Start. To access the Home Assistant directories from the other device, follow these steps: 1. Go to [Settings \> System \> Network](https://my.home-assistant.io/redirect/network) and take note of the Host name. - Alternatively, you can look up the host name or IP address of your Home Assistant on your router. 2. How you connect from another device to Home Assistant depends on your system. Use one of the following options: - On Windows: Open File Explorer and in the address bar, enter the IP address or hostname with two backslashes as `\\your.ha.ip.address` or `\\hostname`. ![Screenshot of File Explorer displaying the navigation to a file share using an IP address](https://www.home-assistant.io/images/hassio/screenshots/file_explorer.png) Screenshot of File Explorer displaying the navigation to a file share using an IP address - On OS X: Open Finder and select Go \> Connect to Server… and enter the IP address or hostname as `smb://your.ha.ip.address` or `smb://hostname`. - On Ubuntu: Open Files and in the address bar, enter the IP address or hostname as `smb://your.ha.ip.address` or `smb://hostname`. 3. Enter the credentials you entered in the Samba app configuration. - You also have the option of having the credentials stored so that you do not need to enter them again. 4. Done! You now have access to the directories which you can then mount as a drive or pin to Quick Access. * ### Installing and using the Visual Studio Code (VSC) app The Studio Code Server app provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64/ARM64 machines. The app also provides access to the Home Assistant Command Line Interface (CLI) using VSC’s built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and apps, creating/restoring backups, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). ![Screenshot of an example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.](https://www.home-assistant.io/images/docs/configuration/config-yaml_via-vscode.png) Example of a configuration.yaml file, accessed using the Studio Code Server app on a Home Assistant Operating System installation. To install and use the Studio Code Server in Home Assistant, follow these steps: 1. To install the app, go to [Settings \> Apps \> Studio Code Server](https://my.home-assistant.io/redirect/supervisor_addon?addon=a0d7b954_vscode) and install the app. 2. Once you have the app installed, if you want, select the Show in sidebar option. Then, select Start. 3. For information on configuration settings, open the Documentation tab. 4. To start browsing, on the Info tab, select Open Web UI. * ### Installing and using the File Editor app The File Editor app is a web-based file system browser and text editor. It is a more basic and light weight alternative to Visual Studio Code. YAML files are automatically checked for syntax errors while editing. ![Screenshot of an example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.](https://www.home-assistant.io/images/docs/configuration/config-yaml_via-file-editor.png) Example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation. To install and use the File Editor in Home Assistant, follow these steps: 1. To install the app, go to [Settings \> Apps \> File editor](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_configurator). - Once you have the app installed, you can edit files within your `/config` directory. 2. If you want to be able to access directories outside the `/config` directory, you need to disable an option in the app configuration. - Go to the app under [Settings \> Apps \> File editor](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_configurator). - Open the Configuration tab. - In the configuration settings, disable the Enforce basepath option. - Note: The Enforce basepath option is intended to protect you from inadvertently making changes to settings files. 3. For information on other configuration settings, open the Documentation tab. 4. To confirm your changes, select Save. 5. To start browsing, on the Info tab, select Open Web UI. * ### Installing and using the SSH app If you want to use the Home Assistant command line or an SSH client, you can do this through the Terminal & SSH app. The Terminal & SSH app provides the following functionalities: - It provides a web terminal that you can access from the Home Assistant user interface. - It allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and apps, creating/restoring backups, and more. - For a list of command line commands, refer to [Home Assistant via Command Line](https://www.home-assistant.io/common-tasks/os#home-assistant-via-the-command-line). - It allows connecting to your system using an SSH client. - It also includes common tools like nano and vi editors. - The Terminal & SSH app does not provide access to the underlying host file system. To get started with the Terminal & SSH app, follow these steps: 1. In the bottom left, select your user to open the [Profile](https://my.home-assistant.io/redirect/profile) page. Make sure Advanced Mode is enabled. 2. To install the app, go to the app store under [Settings \> Apps](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_ssh) and install the Terminal & SSH app. 3. To use the web terminal, start the app, then select Open Web UI. - You can now start typing your [commands](https://www.home-assistant.io/common-tasks/os#home-assistant-via-the-command-line). 4. If you want to access from an ssh client, you need to enter credentials: - Open the Configuration page. - Enter a password or authorized Keys. - Then save and start the app. ## Backup To learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under [common tasks](https://www.home-assistant.io/common-tasks/general/#backups). ### Alternative: Creating a backup using the Home Assistant Command Line Interface In general, to create or restore from a backup, follow the steps described under [common tasks](https://www.home-assistant.io/common-tasks/general/#backups). However, If you have the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you can also create a backup from the command line. Follow these steps: 1. `ha backups list` - lists backups and their slugnames 2. `ha backups restore slugname` - restores a specific backup 3. `ha backups new --name nameofbackup` - create a backup For additional information about command line usage, use the `ha help` command or refer to the [Home Assistant Command Line documentation](https://www.home-assistant.io/common-tasks/os/#home-assistant-via-the-command-line). ## Updating Home Assistant If you have the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you receive update notifications from different components: - Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. - Home Assistant SupervisorThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System. - Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated. - AppsApps are additional standalone third-party software packages that can be installed on Home Assistant OS. [\[Learn more\]](https://www.home-assistant.io/getting-started/concepts-terminology/#apps), if you have any installed Each of these components needs to be updated separately. ### Updating the Home Assistant Operating System Updates of the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. are independent of other updates. They do not trigger repair issues and are usually backward-compatible. #### Prerequisites - [Backup your installation](https://www.home-assistant.io/common-tasks/general/#backups). - Make sure the backup is stored on a [backup location](https://www.home-assistant.io/common-tasks/general/#defining-backup-locations) outside of the device where Home Assistant is installed. - For example, if Home Assistant is installed on [Home Assistant Green](https://www.home-assistant.io/green), make sure it is stored on [Home Assistant Cloud](https://www.home-assistant.io/common-tasks/general/#about-the-backup-storage-on-home-assistant-cloud) or another location. - So that you can [restore from that backup](https://www.home-assistant.io/common-tasks/general/#restoring-a-backup) in case there is an issue with the system. #### To update the Home Assistant Operating System Using the UI Using the CLI 1. Open the Settings panel. 2. On the top you will be presented with an update notification. - Troubleshooting: If you do not see that notification: - In the top right corner, select the three dots menu and select Check for updates. - Go to [System \> Updates](https://my.home-assistant.io/redirect/updates). - Select the update notification. - Select the cogwheel , then set Visible to active. 3. Open the notification for the component you want to update. 4. If you want to update the system first (recommended), enable the backup toggle. 5. Select Update. 6. Check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed. ``` ha os update ``` This updates to the latest version. If you want to update to a specific version instead, use `ha os update --version 15.2`. Advanced: changing the boot slot used during the update #### About boot slots used during the update The Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. uses two boot slots. On first installation, boot slot A is used. After that, on each Operating System update, the other boot slot is updated and reboot is triggered. On that reboot, the system boots from the other boot slot (A ➝ B ➝ A,…). When booting fails, the system automatically uses the previous boot slot, so that it boots from the last working operating system. #### Changing the boot slot used You can manually define that the previous boot slot is used. This can be useful in cases where the system boots but something still seems wrong. For example, when the device is no longer correctly detected or you see another issue that might be related to the latest update of the operating system. 1. To check which boot slot is currently in use and what OS versions are installed in the individual slots, in the Home Assistant command line, enter the following command: ``` ha os info ``` 2. To change the boot slot, enter the following command: - This will boot into the other (previous) OS version. ``` ha os boot-slot other ``` Alternatively, if the Operating Systems runs on a platform that uses the GRUB bootloader, a boot menu is presented early in the boot. The alternative boot slot can be selected here, marking it active for future boots if the following boot attempt is successful. ### Updating Home Assistant Core #### Prerequisites 1. [Back up your installation](https://www.home-assistant.io/common-tasks/general/#backups) and store the backup and the [backup emergency kit](https://www.home-assistant.io/more-info/backup-emergency-kit/) somewhere safe. - This ensures that you can [restore your installation from backup](https://www.home-assistant.io/common-tasks/general/#restoring-a-backup) if needed. 2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](https://www.home-assistant.io/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for Backward-incompatible changes. #### To update Home Assistant Core To update Home Assistant Core, choose one of the following options. Using the UI Using the CLI 1. Open your Home Assistant UI. 2. Go to the Settings panel. 3. On the top you will be presented with an update notification. - Troubleshooting: If you do not see that notification: - In the top right corner, select the three dots menu and select Check for updates. - Go to [System \> Updates](https://my.home-assistant.io/redirect/updates). - Select the update notification. - Select the cogwheel , then set Visible to active. 1. Open the notification for the component you want to update. 2. If you want to backup the system first (recommended), enable the backup toggle. 3. Select Update. 4. After the update completed, check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed. ``` ha core update --backup ``` The `--backup` flag here ensures that you have a partial backup of your current setup in case you need to downgrade. ## Network storage You can configure both Network File System (NFS) and Samba/Windows (CIFS) targets to be used within Home Assistant and apps. To list all your currently connected network storages, go to [Settings \> System \> Storage](https://my.home-assistant.io/redirect/storage) in the UI. Important You need to update to Home Assistant Operating System 10.2 before you can use this feature. ![](https://www.home-assistant.io/images/screenshots/network-storage/list_light.png) Screenshot of the list of network shares inside the storage panel. ### Add a new network storage 1. Go to [Settings \> System \> Storage](https://my.home-assistant.io/redirect/storage) in the UI. 2. Select Add network storage. 3. Fill out all the information for your network storage. 4. Select Connect. ![](https://www.home-assistant.io/images/screenshots/network-storage/connect_light.png) Screenshot of connecting a new network storage. #### Network storage configuration Name This is the name that will be used for the mounted directory on your system. Usage Here, you select how the target should be used. [See usage types below](https://www.home-assistant.io/common-tasks/os/#usage-types) Server The IP/hostname of the server running NFS/CIFS. Protocol3 The service the server is using for the network storage. \[NFS\]1 Remote share path The path used to connect to the remote storage server. \[CIFS\]2 Username The username to use when connecting to the storage server. Use User Principal Name for domain accounts. For example: `[email protected]`. \[CIFS\]2 Password The password to use when connecting to the storage server. \[CIFS\]2 Share The share to connect to on the storage server. 1 Options prefixed with `[NFS]` are only available for NFS targets. 2 Options prefixed with `[CIFS]` are only available for CIFS targets. 3 For the `CIFS` option, only version 2.1+ is supported. ##### Usage types Backup This will become a target. You can use it when creating an automatic or manual backup. The first storage you add of this type becomes your new default target. If you want to change the default target, [check out the documentation below](https://www.home-assistant.io/common-tasks/os/#change-default-local-backup-location). Media A new directory with the name you gave your network storage will be created under `/media`. This directory can be accessed by Home Assistant and apps. Share A new directory with the name you gave your network storage will be created under `/share`. This directory can be accessed by Home Assistant and apps. ### Change default local backup location By default, the first network storage of type Backup that you add is used as your local default backup location. If you want to change the local network storage that is used to store your backups, follow these steps: 1. Go to [Settings \> System \> Backups](https://my.home-assistant.io/redirect/backup). 2. Select Settings and history. 3. In the top-right corner, select the three dots menu and select Change default action location. 4. Select your preferred network location and save your changes. ![Select default location used for local backup](https://www.home-assistant.io/images/screenshots/network-storage/backup_select_local_default.png) 5. Troubleshooting: Don’t see your external storage location? This list contains only the network storage targets you have added of type Backup. ## Lost Password and password reset Please refer to the [I’m locked out\!](https://www.home-assistant.io/docs/locked_out/) documentation page. ## Installing a third-party app repository Home Assistant allows anyone to create an app repository to share their own apps with the community. Warning Home Assistant cannot guarantee the quality or security of third-party apps. Use at your own risk. To add an app repository, follow these steps: 1. Copy the URL of the repository. - The URL is the git repository clone URL (on GitHub, use the Code button and copy the HTTPS URL). - This documentation uses an example app repository. It is not practically useful but follows the same steps. - If you are interested in app development, refer to our [Home Assistant app development documentation](https://developers.home-assistant.io/docs/apps/). ``` https://github.com/home-assistant/hassio-addons-example ``` 2. Go to [Settings \> Apps](https://my.home-assistant.io/redirect/supervisor) and select App store. ![Screenshot of the Home Assistant app store](https://www.home-assistant.io/images/getting-started/app-store.png) 3. In the top-right corner, select the three dots menu, and select Repositories. 4. Add the URL of the repository and select Add. ![Screenshot of the app store](https://www.home-assistant.io/images/getting-started/adding_repositories-url.png) - Result: A new card for the third-party repository will appear. ![Screenshot of the app store](https://www.home-assistant.io/images/getting-started/add-ons-community_example.png) ### Troubleshooting: Repository is not showing up If you have added an app repository, but it’s not showing up, make sure to refresh your browser. If it still doesn’t show up, the app repository may contain invalid configuration data. 1. Go to [Settings \> System \> Logs](https://my.home-assistant.io/redirect/logs) and select Supervisor in the top right corner to get the Supervisor log. - It should tell you what went wrong. 2. Report this information to the app repository author. ## Configuration check After changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core. ### Running a configuration check from the UI 1. Go to [your user profile](https://my.home-assistant.io/redirect/profile) and enable Advanced Mode. 2. Go to [Settings \> Developer tools \> YAML](https://my.home-assistant.io/redirect/server_controls) and in the Configuration validation section, select the Check configuration button. - This is to make sure there are no syntax errors before restarting Home Assistant. - It checks for valid YAMLYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the `configuration.yaml` or `automations.yaml` files. [\[Learn more\]](https://www.home-assistant.io/docs/configuration/yaml/) and valid config structures. 3. If you need to do a more comprehensive configuration check, [run the check from the CLI](https://www.home-assistant.io/common-tasks/os/#to-run-a-configuration-check-from-the-cli). ### Running a configuration check from the CLI Use the following command to check if the configuration is valid. The command line configuration check validates the YAMLYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the `configuration.yaml` or `automations.yaml` files. [\[Learn more\]](https://www.home-assistant.io/docs/configuration/yaml/) files and checks for valid config structures, as well as some other elements. ``` ha core check ``` ## Home Assistant versions To see which version your system is running, go to [Settings \> About](https://my.home-assistant.io/redirect/info). ### Feature preview If you want to preview upcoming features, you can enable preview under [Settings \> System \> Labs](https://my.home-assistant.io/redirect/labs). Labs allows you to preview selected features that are stable but are still being fine-tuned. Preview is different from installing a beta or development version, which are used for development and testing. For more information, refer to the [Labs documentation](https://www.home-assistant.io/integrations/labs). ### Running a beta version If you would like to test next release before anyone else, you can install the beta version. From the UI From the CLI 1. In Home Assistant, go to [System \> Updates](https://my.home-assistant.io/redirect/updates). 2. In the top-right corner, select the three dots menu. 3. Select Join beta. 4. Go to the [Configuration](https://my.home-assistant.io/redirect/configuration) panel. 5. Install the update that is presented to you. - Troubleshooting: If you do not see that notification: - In the top right corner, select the three dots menu and select Check for updates. - Go to [System \> Updates](https://my.home-assistant.io/redirect/updates). - Select the update notification. - Select the cogwheel , then set Visible to active. 1. Join the beta channel. ``` ha supervisor options --channel beta ``` 2. Reload Home Assistant Supervisor. ``` ha supervisor reload ``` 3. Update Home Assistant Core to the latest beta version. ``` ha core update --backup ``` The `--backup` flag here ensures that you have a partial backup of your current setup in case you need to downgrade. ### Running a development version If you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to `dev`. Caution The `dev` branch is likely to be unstable. Potential consequences include loss of data and instance corruption. 1. Join the dev channel. ``` ha supervisor options --channel dev ``` 2. Reload the Home Assistant SupervisorThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System.. ``` ha supervisor reload ``` 3. Update Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated. to the latest dev version. ``` ha core update --backup ``` The `--backup` flag here ensures that you have a partial backup of your current setup incase you need to downgrade. ### Running a specific version To upgrade to a specific version, you can use the command line (CLI). The example below shows how to upgrade to `2026.4.1`. To learn how to get started with the command line in Home Assistant, refer to the [SSH app setup instructions](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-ssh-app). ``` ha core update --version 2026.4.1 --backup ``` The `--backup` flag here ensures that you have a partial backup of your current setup in case you need to downgrade later. To downgrade your installation, do a [partial restore of a backup](https://www.home-assistant.io/common-tasks/general/#backups) instead. ## Using external data disk Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. supports storing data on a secondary storage medium. For example, this can be a second internal SSD or HDD or a USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster. ![Graphics showing the architecture of the data disk feature](https://www.home-assistant.io/images/haos/usb-data-disk.png) The data disk feature can be used on an existing installation without losing data: The system will move existing data to the external data disk automatically. However, it is recommended to create and download a full [Backup](https://www.home-assistant.io/common-tasks/os/#backups) before proceeding\! Caution All data on the target disk will be overwritten\! Important The storage capacity of the external data disk must be larger than the storage capacity of the existing (boot) disk. Important If you have been using a data disk previously with Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., you need to use your host computer to delete all partitions before using it as a data disk again. ### Using UI to move the data partition 1. Connect the data disk to your system. 2. Go to [Settings \> System \> Storage](https://my.home-assistant.io/redirect/storage) in the UI. 3. Select Move data disk. 4. Select the data disk from the list of available devices. 5. Select Move. - Depending on the amount of data, this may take a while. ### Using CLI to move the data partition To see the current data disk use: ``` $ ha os info ... data_disk: /dev/mmcblk1p4 ... ``` To get a list of potential targets which can be used by `datadisk`: ``` ha os datadisk list ``` To initiate the move to the new data disk use the `move` command: ``` ha os datadisk move /dev/sdx ``` The system will prepare the data disk and immediately reboot. The reboot will take 10 minutes or more depending on the speed of the new data disk; please be patient\! Warning Using an USB attached SSD can draw quite some power. For instance on Raspberry Pi 3 the official Raspberry Pi power supply (PSU) only provides 2.5A which can be too tight. Use a more powerful power supply if you experience issues. Alternatively use a powered USB hub. Connect the Hub to one of the USB slots of your Raspberry Pi, and connect the SSD to the Hub. In this setup the power supply of the Hub will power the attached device(s). ### Migrating an external data disk to another system This section shows how to move an external data disk from one system to another. This can be an option if the following elements apply to your use case: - You already have a functioning Home Assistant instance (system 1) that is using an external data disk. - You have another, new, Home Assistant instance (system 2). - You now want to use the data disk of system 1 on system 2 instead. The aim is to migrate the data from system 1 to system 2. One way to do this is by [restoring a backup](https://www.home-assistant.io/common-tasks/general/#restoring-a-backup). The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk or if your external disk has more storage capacity than your new system. #### Prerequisites - A Home Assistant instance using an external data disk (system 1) - A Home Assistant instance to which you want to move the external data disk (system 2) #### To migrate an external data disk to another system To migrate an external data disk from one system to another, follow these steps: 1. [Create a backup](https://www.home-assistant.io/common-tasks/general/#backups) of both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data). 2. Shut down system 1 and remove the data disk. 3. Make sure system 2 has Home Assistant OS installed, and Home Assistant is up and running. Home Assistant is using the data disk (partition) on the boot drive (e.g. SD card) at this point. 4. Make sure system 2 has completed the basic [onboarding](https://www.home-assistant.io/getting-started/onboarding/) steps, including the last steps where devices are discovered automatically. 5. Plug the external disk into system 2 and go to the Settings \> System. Select the three dots menu, and Restart Home Assistant \> Reboot system. Result: A repair issue is displayed Multiple data disks detected. - The repair issue comes up because system 2 now sees two file systems with an identical name. During a reboot, there is a name conflict with the existing data disk as it is undefined which file system should be used. This can lead to a random selection of the system you end up with. Hence you must make a decision. 6. Open the repair issue and choose one of the options: - Select Use the detected data disk instead of the current system. - This will override the current file system of system 2 and use your external data disk instead. - You won’t have access anymore to the current Home Assistant data. It will be marked as inactive data disk. - If you changed your mind about using the external data disk: - Unplug the external data disk. - If you cannot unplug the external data disk for some reason, select Mark as inactive data disk (rename file system). - This makes sure that there is no name conflict after rebooting. - It also means you cannot use the file system that is stored on your external disk. - You keep using the current file system of system 1. ## Home Assistant via the command line On the [SSH command line](https://www.home-assistant.io/common-tasks/os/), you can use the `ha` command to retrieve logs, check the details of connected hardware, and more. ### Home Assistant ``` ha core check ha core info ha core logs ha core options ha core rebuild ha core restart ha core restart --safe-mode ha core start ha core stats ha core stop ha core update ``` ### Supervisor ``` ha supervisor info ha supervisor logs ha supervisor reload ha supervisor update ``` ### Host ``` ha host reboot ha host shutdown ha host update ``` ### Hardware ``` ha hardware info ha hardware audio ``` ### Usage examples To update Home Assistant to a specific version, use the command: ``` ha core update --version x.y.z ``` Replace x.y.z with the desired version like `--version 2026.4.1` You can get a better description of the CLI capabilities by typing `ha help`: ``` The Home Assistant CLI is a small and simple command line utility that allows you to control and configure different aspects of Home Assistant Usage: ha [command] Available Commands: addons Install, update, remove and configure Home Assistant apps audio Audio device handling. authentication Authentication for Home Assistant users. backups Create, restore and remove backups banner Prints the CLI Home Assistant banner along with some useful information cli Get information, update or configure the Home Assistant cli backend core Provides control of the Home Assistant Core dns Get information, update or configure the Home Assistant DNS server docker Docker backend specific for info and OCI configuration hardware Provides hardware information about your system help Help about any command host Control the host/system that Home Assistant is running on info Provides a general Home Assistant information overview jobs Get information and manage running jobs multicast Get information, update or configure the Home Assistant Multicast network Network specific for updating, info and configuration imports observer Get information, update or configure the Home Assistant observer os Operating System specific for updating, info and configuration imports resolution Resolution center of Supervisor, show issues and suggest solutions supervisor Monitor, control and configure the Home Assistant Supervisor Flags: --api-token string Home Assistant Supervisor API token --config string Optional config file (default is $HOME/.homeassistant.yaml) --endpoint string Endpoint for Home Assistant Supervisor (default is 'supervisor') -h, --help help for ha --log-level string Log level (defaults to Warn) --no-progress Disable the progress spinner --raw-json Output raw JSON from the API Use "ha [command] --help" for more information about a command. ``` ### Console access You can also access the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. via a directly connected keyboard and monitor, the console. #### Wiping the data disk from the command line In Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., the `ha os datadisk wipe` command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed apps. The command `ha os datadisk wipe` marks the data partition (either internal on the eMMC or the SD card, or on an external attached data disk) as to be cleared on the next reboot. The command automatically reboots the system. Upon reboot, the data is cleared. Then the system continues to boot and reinstalls the latest version of all Home Assistant components. The `ha os datadisk wipe` command can only be run from the local terminal. Connect a display and keyboard and use the terminal. Note, some systems have a reset button you can use to clear the data disk, instead of using the command line: - If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 5, use the command line steps described above. - If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 4, there is a red hardware button to wipe the data disk. Follow the procedure on [resetting the Home Assistant Yellow](https://support.nabucasa.com/hc/articles/25463622043165). - If you have a Home Assistant Green, there is a black hardware button to wipe the data disk. Follow the procedure on [resetting the Home Assistant Green](https://support.nabucasa.com/hc/en-us/articles/25161225495837). #### Listing all users from the command line In Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., the `ha auth list` command lists all users that are registered on your Home Assistant. The `ha auth list` command can only be run from the local terminal. Connect a display and keyboard and use the terminal. ## Enable duplicate log file By default, Home Assistant Core logs are sent to the Systemd Journal, which can be read using the [`ha core logs` command](https://www.home-assistant.io/common-tasks/os/#home-assistant-via-the-command-line). If you need logs to also be written to a file (`/config/home-assistant.log`), you can enable the duplicated log file option using the [command line](https://www.home-assistant.io/common-tasks/os/#home-assistant-via-the-command-line): ``` ha core options --duplicate-log-file=true ha core rebuild ha core restart ``` To disable it: ``` ha core options --duplicate-log-file=false ha core rebuild ha core restart ``` ## Enable I2C Home Assistant using the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. which is a managed environment, which means you can’t use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to - Enable I2C for the Home Assistant Operating System - Setup I2C devices e.g. sensors ### Enable I2C with an SD card reader #### Access the boot partition You will need: - SD card reader - SD card with Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. flashed on it Shutdown/turn-off your Home Assistant installation and unplug the SD card. Plug the SD card into an SD card reader and find a drive/file system named `hassos-boot`. The file system might be shown/mounted automatically. If not, use your operating systems disk management utility to find the SD card reader and make sure the first partition is available. #### Add files to enable I2C - In the root of the `hassos-boot` partition, add a new folder called `CONFIG`. - In the `CONFIG` folder, add another new folder called `modules`. - Inside the `modules` folder add a text file called `rpi-i2c.conf` with the following content: ``` i2c-dev ``` - In the root of the `hassos-boot` partition, edit the file called `config.txt` add two lines to it: ``` dtparam=i2c_vc=on dtparam=i2c_arm=on ``` #### Start with the new OS configuration - Insert the SD card back into your Raspberry Pi. - On startup, the `hassos-config.service` will automatically pickup the new `rpi-i2c.conf` configuration. - Another reboot might be necessary to make sure the just imported `rpi-i2c.conf` is present at boot time. ### Enable I2C via Home Assistant Operating System Terminal Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.. You can enable I2C via this terminal: - Login as `root`. - Type `login` and press enter to access the shell: ``` mkdir -p /mnt/boot/CONFIG/modules echo i2c-dev > /mnt/boot/CONFIG/modules/rpi-i2c.conf echo dtparam=i2c_vc=on >> /mnt/boot/config.txt echo dtparam=i2c_arm=on >> /mnt/boot/config.txt sync reboot ``` ### Troubleshooting After rebooting the host there should be `i2c-0` and similar device files in `/dev`. If such device files are missing, enabling I2C failed for some reason. You can check the status of I2C kernel modules by using `lsmod \| grep i2c` in the terminal. If they are loaded, you should find at least the entry `i2c_dev`. Active usage of the modules is indicated by a number, e.g. `i2c_dev 20480 2` would indicate two active I2C device files. An active I2C can also be checked with a multi meter showing 3.3 V on the I2C pins GPIO2 and GPIO3. ## Related topics - [Configuration.yaml](https://www.home-assistant.io/docs/configuration/) #### Help us improve our documentation Suggest an edit to this page, or provide/view feedback for this page. - [Edit](https://github.com/home-assistant/home-assistant.io/tree/current/source/common-tasks/os.markdown "Edit this page") - [Provide feedback](https://github.com/home-assistant/home-assistant.io/issues/new?template=feedback.yml&url=https%3A%2F%2Fwww.home-assistant.io%2Fcommon-tasks%2Fos%2F&version=2026.4.1&labels=current "Provide feedback on this page") - [View given feedback](https://github.com/home-assistant/home-assistant.io/issues?utf8=%E2%9C%93&q=%22%2Fcommon-tasks%2Fos%2F%22&in=body "View given feedback for this page") ## Documentation - [Overview](https://www.home-assistant.io/docs/) \\| [FAQ](https://www.home-assistant.io/faq/) \\| [Glossary](https://www.home-assistant.io/docs/glossary/) - [Automations](https://www.home-assistant.io/docs/automation/) - [Dashboards](https://www.home-assistant.io/dashboards) - [Voice assistants](https://www.home-assistant.io/voice_control/) - [Organization](https://www.home-assistant.io/docs/organizing/) - [Home energy management](https://www.home-assistant.io/docs/energy/) - [Templating](https://www.home-assistant.io/docs/templating/) - [Common tasks](https://www.home-assistant.io/common-tasks/general/) - [Installation independent](https://www.home-assistant.io/common-tasks/general/) - [Home Assistant Operating System](https://www.home-assistant.io/common-tasks/os/) - [Home Assistant Container](https://www.home-assistant.io/common-tasks/container/) - [General troubleshooting](https://www.home-assistant.io/docs/troubleshooting_general/) - [Advanced configuration](https://www.home-assistant.io/docs/configuration/) - [Authentication](https://www.home-assistant.io/docs/authentication/) - [Backend](https://www.home-assistant.io/docs/backend/) - [Tools and helpers](https://www.home-assistant.io/docs/tools/) - [iOS and Android apps](https://companion.home-assistant.io/docs) - [MQTT](https://www.home-assistant.io/integrations/mqtt) - Official hardware - [Home Assistant Green](https://support.nabucasa.com/hc/categories/24638797677853) - [Home Assistant Connect ZBT-1](https://support.nabucasa.com/hc/categories/24734620813469) - [Home Assistant Connect ZBT-2](https://support.nabucasa.com/hc/categories/29400540866973) - [Home Assistant Connect ZWA-2](https://support.nabucasa.com/hc/categories/28669861145885) - [Home Assistant Yellow](https://support.nabucasa.com/hc/categories/24734575925149) - [Home Assistant Voice Preview Edition](https://support.nabucasa.com/hc/categories/24451727188125) ## On this page - [Configuring access to files](https://www.home-assistant.io/common-tasks/os/#configuring-access-to-files) - [Installing and using the Samba app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-samba-app) - [Installing and using the Visual Studio Code (VSC) app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-app) - [Installing and using the File Editor app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-file-editor-app) - [Installing and using the SSH app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-ssh-app) - [Backup](https://www.home-assistant.io/common-tasks/os/#backup) - [Alternative: Creating a backup using the Home Assistant Command Line Interface](https://www.home-assistant.io/common-tasks/os/#alternative-creating-a-backup-using-the-home-assistant-command-line-interface) - [Updating Home Assistant](https://www.home-assistant.io/common-tasks/os/#updating-home-assistant) - [Updating the Home Assistant Operating System](https://www.home-assistant.io/common-tasks/os/#updating-the-home-assistant-operating-system) - [Updating Home Assistant Core](https://www.home-assistant.io/common-tasks/os/#updating-home-assistant-core) - [Network storage](https://www.home-assistant.io/common-tasks/os/#network-storage) - [Add a new network storage](https://www.home-assistant.io/common-tasks/os/#add-a-new-network-storage) - [Change default local backup location](https://www.home-assistant.io/common-tasks/os/#change-default-local-backup-location) - [Lost Password and password reset](https://www.home-assistant.io/common-tasks/os/#lost-password-and-password-reset) - [Installing a third-party app repository](https://www.home-assistant.io/common-tasks/os/#installing-a-third-party-app-repository) - [Troubleshooting: Repository is not showing up](https://www.home-assistant.io/common-tasks/os/#troubleshooting-repository-is-not-showing-up) - [Configuration check](https://www.home-assistant.io/common-tasks/os/#configuration-check) - [Running a configuration check from the UI](https://www.home-assistant.io/common-tasks/os/#running-a-configuration-check-from-the-ui) - [Running a configuration check from the CLI](https://www.home-assistant.io/common-tasks/os/#running-a-configuration-check-from-the-cli) - [Home Assistant versions](https://www.home-assistant.io/common-tasks/os/#home-assistant-versions) - [Feature preview](https://www.home-assistant.io/common-tasks/os/#feature-preview) - [Running a beta version](https://www.home-assistant.io/common-tasks/os/#running-a-beta-version) - [Running a development version](https://www.home-assistant.io/common-tasks/os/#running-a-development-version) - [Running a specific version](https://www.home-assistant.io/common-tasks/os/#running-a-specific-version) - [Using external data disk](https://www.home-assistant.io/common-tasks/os/#using-external-data-disk) - [Using UI to move the data partition](https://www.home-assistant.io/common-tasks/os/#using-ui-to-move-the-data-partition) - [Using CLI to move the data partition](https://www.home-assistant.io/common-tasks/os/#using-cli-to-move-the-data-partition) - [Migrating an external data disk to another system](https://www.home-assistant.io/common-tasks/os/#migrating-an-external-data-disk-to-another-system) - [Home Assistant via the command line](https://www.home-assistant.io/common-tasks/os/#home-assistant-via-the-command-line) - [Home Assistant](https://www.home-assistant.io/common-tasks/os/#home-assistant) - [Supervisor](https://www.home-assistant.io/common-tasks/os/#supervisor) - [Host](https://www.home-assistant.io/common-tasks/os/#host) - [Hardware](https://www.home-assistant.io/common-tasks/os/#hardware) - [Usage examples](https://www.home-assistant.io/common-tasks/os/#usage-examples) - [Console access](https://www.home-assistant.io/common-tasks/os/#console-access) - [Enable duplicate log file](https://www.home-assistant.io/common-tasks/os/#enable-duplicate-log-file) - [Enable I2C](https://www.home-assistant.io/common-tasks/os/#enable-i2c) - [Enable I2C with an SD card reader](https://www.home-assistant.io/common-tasks/os/#enable-i2c-with-an-sd-card-reader) - [Enable I2C via Home Assistant Operating System Terminal](https://www.home-assistant.io/common-tasks/os/#enable-i2c-via-home-assistant-operating-system-terminal) - [Troubleshooting](https://www.home-assistant.io/common-tasks/os/#troubleshooting) - [Related topics](https://www.home-assistant.io/common-tasks/os/#related-topics) Back to top ![Home Assistant](https://www.home-assistant.io/images/footer-logo-text.svg) Home Assistant is a project from the [Open Home Foundation](https://www.openhomefoundation.org/), sponsored by [Nabu Casa](https://www.nabucasa.com/). ### Join us and contribute\! - [GitHub repo](https://github.com/home-assistant/) - [Developers Portal](https://developers.home-assistant.io/) - [Design Portal](https://design.home-assistant.io/) - [Data Science Portal](https://data.home-assistant.io/) - [Community Forum](https://community.home-assistant.io/) - [Creator Network](https://creators.home-assistant.io/) - [Works With Home Assistant](https://works-with.home-assistant.io/) - [Our community](https://www.home-assistant.io/community) - [Reporting issues](https://www.home-assistant.io/help/reporting_issues/) ### System status - [Integration Alerts](https://alerts.home-assistant.io/) - [Security Alerts](https://www.home-assistant.io/security/) - [System Status](https://status.home-assistant.io/) ### Companion apps - [iOS and Apple devices](https://apps.apple.com/app/id1099568401) - [Android and Wear OS](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android) - [...and more\!](https://companion.home-assistant.io/) ### Support us - [Merch store](https://store.openhomefoundation.org/) - [Home Assistant Cloud](https://www.home-assistant.io/cloud/) ### Governance - [Privacy Notices](https://www.home-assistant.io/privacy/) - [Contributor License Agreement](https://www.home-assistant.io/developers/cla/) - [Terms of Service](https://www.home-assistant.io/tos/) - [Code of Conduct](https://www.home-assistant.io/code_of_conduct/) - [Credits](https://www.home-assistant.io/developers/credits/) - [License](https://www.home-assistant.io/developers/license/) ### Follow us [Sign up for our newsletter](https://newsletter.openhomefoundation.org/#/portal) For partnership inquiries please check out [Works With Home Assistant](https://works-with.home-assistant.io/). For media, [email our team](https://www.home-assistant.io/cdn-cgi/l/email-protection#1c717978757d5c736c7972747371797a736972787d6875737232736e7b). For other questions, you can [contact support](https://www.home-assistant.io/cdn-cgi/l/email-protection#80e8e5ececefc0e8efede5ade1f3f3e9f3f4e1eef4aee9ef) (No technical support!) Website powered by [Jekyll](https://jekyllrb.com/) Originally based on the [Oscailte theme](https://github.com/coogie/oscailte) [![Deploys by Netlify Badge](https://www.home-assistant.io/images/frontpage/netlify.svg)](https://www.netlify.com/)
Readable Markdown	This section will provide guides to some common tasks and information which you will need in order to run, maintain, and edit your Home Assistant OS system. For further details on any particular subject, make sure to refer to the documentation for specific apps (formerly known as add-ons) or topics listed here. ## Configuring access to files Your Home Assistant Operating server includes two repositories by default: The official core app repository, and the community app repository. All of the apps mentioned here can be installed by navigating to the app store using [Settings \> Apps \> Install app](https://my.home-assistant.io/redirect/supervisor_store) in the UI. One of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several apps commonly used for this, and most users employ a mix of various apps. Default directories on the host are mapped to the apps so that they can be accessed by the services any particular app might provide. On the host system these directories exist on the `/data` partition at `/mnt/data/supervisor/`. Using any of the apps listed below, the following directories are made available for access: - `addons` - `backup` - `config` - `media` - `share` - `ssl` * ### Installing and using the Samba app The Samba app allows you to share the directories on Home Assistant with other systems on your network. After installing the app, you can then also edit files using the editor of your preference from your client computer. This app can be installed from the app store’s official repository. To install the app, follow these steps: 1. Go to [Settings \> Apps \> Samba share](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_samba) and select Install. 2. On the Configuration tab, define Username and Password, store them in a safe place, and save your changes. - You can specify any username and password. - They are not related to the login credentials you use to log in to Home Assistant or to log in to the computer from which you are accessing the files. - The app won’t start if username and password are not defined. 3. For further configuration information, refer to the Documentation tab. 4. To start the app, on the Information tab, select Start. To access the Home Assistant directories from the other device, follow these steps: 1. Go to [Settings \> System \> Network](https://my.home-assistant.io/redirect/network) and take note of the Host name. - Alternatively, you can look up the host name or IP address of your Home Assistant on your router. 2. How you connect from another device to Home Assistant depends on your system. Use one of the following options: - On Windows: Open File Explorer and in the address bar, enter the IP address or hostname with two backslashes as `\\your.ha.ip.address` or `\\hostname`. ![Screenshot of File Explorer displaying the navigation to a file share using an IP address](https://www.home-assistant.io/images/hassio/screenshots/file_explorer.png) Screenshot of File Explorer displaying the navigation to a file share using an IP address - On OS X: Open Finder and select Go \> Connect to Server… and enter the IP address or hostname as `smb://your.ha.ip.address` or `smb://hostname`. - On Ubuntu: Open Files and in the address bar, enter the IP address or hostname as `smb://your.ha.ip.address` or `smb://hostname`. 3. Enter the credentials you entered in the Samba app configuration. - You also have the option of having the credentials stored so that you do not need to enter them again. 4. Done! You now have access to the directories which you can then mount as a drive or pin to Quick Access. * ### Installing and using the Visual Studio Code (VSC) app The Studio Code Server app provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64/ARM64 machines. The app also provides access to the Home Assistant Command Line Interface (CLI) using VSC’s built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and apps, creating/restoring backups, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). ![Screenshot of an example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.](https://www.home-assistant.io/images/docs/configuration/config-yaml_via-vscode.png) Example of a configuration.yaml file, accessed using the Studio Code Server app on a Home Assistant Operating System installation. To install and use the Studio Code Server in Home Assistant, follow these steps: 1. To install the app, go to [Settings \> Apps \> Studio Code Server](https://my.home-assistant.io/redirect/supervisor_addon?addon=a0d7b954_vscode) and install the app. 2. Once you have the app installed, if you want, select the Show in sidebar option. Then, select Start. 3. For information on configuration settings, open the Documentation tab. 4. To start browsing, on the Info tab, select Open Web UI. * ### Installing and using the File Editor app The File Editor app is a web-based file system browser and text editor. It is a more basic and light weight alternative to Visual Studio Code. YAML files are automatically checked for syntax errors while editing. ![Screenshot of an example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation.](https://www.home-assistant.io/images/docs/configuration/config-yaml_via-file-editor.png) Example of a configuration.yaml file, accessed using the File editor app on a Home Assistant Operating System installation. To install and use the File Editor in Home Assistant, follow these steps: 1. To install the app, go to [Settings \> Apps \> File editor](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_configurator). - Once you have the app installed, you can edit files within your `/config` directory. 2. If you want to be able to access directories outside the `/config` directory, you need to disable an option in the app configuration. - Go to the app under [Settings \> Apps \> File editor](https://my.home-assistant.io/redirect/supervisor_addon?addon=core_configurator). - Open the Configuration tab. - In the configuration settings, disable the Enforce basepath option. - Note: The Enforce basepath option is intended to protect you from inadvertently making changes to settings files. 3. For information on other configuration settings, open the Documentation tab. 4. To confirm your changes, select Save. 5. To start browsing, on the Info tab, select Open Web UI. * ### Installing and using the SSH app If you want to use the Home Assistant command line or an SSH client, you can do this through the Terminal & SSH app. The Terminal & SSH app provides the following functionalities: - It provides a web terminal that you can access from the Home Assistant user interface. - It allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and apps, creating/restoring backups, and more. - For a list of command line commands, refer to [Home Assistant via Command Line](https://www.home-assistant.io/common-tasks/os#home-assistant-via-the-command-line). - It allows connecting to your system using an SSH client. - It also includes common tools like nano and vi editors. - The Terminal & SSH app does not provide access to the underlying host file system. To get started with the Terminal & SSH app, follow these steps: 1. In the bottom left, select your user to open the [Profile](https://my.home-assistant.io/redirect/profile) page. Make sure Advanced Mode is enabled. 2. To install the app, go to the app store under [Settings \> Apps](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_ssh) and install the Terminal & SSH app. 3. To use the web terminal, start the app, then select Open Web UI. - You can now start typing your [commands](https://www.home-assistant.io/common-tasks/os#home-assistant-via-the-command-line). 4. If you want to access from an ssh client, you need to enter credentials: - Open the Configuration page. - Enter a password or authorized Keys. - Then save and start the app. ## Backup To learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under [common tasks](https://www.home-assistant.io/common-tasks/general/#backups). ### Alternative: Creating a backup using the Home Assistant Command Line Interface In general, to create or restore from a backup, follow the steps described under [common tasks](https://www.home-assistant.io/common-tasks/general/#backups). However, If you have the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you can also create a backup from the command line. Follow these steps: 1. `ha backups list` - lists backups and their slugnames 2. `ha backups restore slugname` - restores a specific backup 3. `ha backups new --name nameofbackup` - create a backup For additional information about command line usage, use the `ha help` command or refer to the [Home Assistant Command Line documentation](https://www.home-assistant.io/common-tasks/os/#home-assistant-via-the-command-line). ## Updating Home Assistant If you have the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installed, you receive update notifications from different components: - Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. - Home Assistant SupervisorThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System. - Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated. - AppsApps are additional standalone third-party software packages that can be installed on Home Assistant OS. [\[Learn more\]](https://www.home-assistant.io/getting-started/concepts-terminology/#apps), if you have any installed Each of these components needs to be updated separately. ### Updating the Home Assistant Operating System Updates of the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. are independent of other updates. They do not trigger repair issues and are usually backward-compatible. #### Prerequisites - [Backup your installation](https://www.home-assistant.io/common-tasks/general/#backups). - Make sure the backup is stored on a [backup location](https://www.home-assistant.io/common-tasks/general/#defining-backup-locations) outside of the device where Home Assistant is installed. - For example, if Home Assistant is installed on [Home Assistant Green](https://www.home-assistant.io/green), make sure it is stored on [Home Assistant Cloud](https://www.home-assistant.io/common-tasks/general/#about-the-backup-storage-on-home-assistant-cloud) or another location. - So that you can [restore from that backup](https://www.home-assistant.io/common-tasks/general/#restoring-a-backup) in case there is an issue with the system. #### To update the Home Assistant Operating System Using the UIUsing the CLI 1. Open the Settings panel. 2. On the top you will be presented with an update notification. - Troubleshooting: If you do not see that notification: - In the top right corner, select the three dots menu and select Check for updates. - Go to [System \> Updates](https://my.home-assistant.io/redirect/updates). - Select the update notification. - Select the cogwheel , then set Visible to active. 3. Open the notification for the component you want to update. 4. If you want to update the system first (recommended), enable the backup toggle. 5. Select Update. 6. Check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed. ``` ha os update ``` This updates to the latest version. If you want to update to a specific version instead, use `ha os update --version 15.2`. Advanced: changing the boot slot used during the update #### About boot slots used during the update The Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. uses two boot slots. On first installation, boot slot A is used. After that, on each Operating System update, the other boot slot is updated and reboot is triggered. On that reboot, the system boots from the other boot slot (A ➝ B ➝ A,…). When booting fails, the system automatically uses the previous boot slot, so that it boots from the last working operating system. #### Changing the boot slot used You can manually define that the previous boot slot is used. This can be useful in cases where the system boots but something still seems wrong. For example, when the device is no longer correctly detected or you see another issue that might be related to the latest update of the operating system. 1. To check which boot slot is currently in use and what OS versions are installed in the individual slots, in the Home Assistant command line, enter the following command: ``` ha os info ``` 2. To change the boot slot, enter the following command: - This will boot into the other (previous) OS version. ``` ha os boot-slot other ``` Alternatively, if the Operating Systems runs on a platform that uses the GRUB bootloader, a boot menu is presented early in the boot. The alternative boot slot can be selected here, marking it active for future boots if the following boot attempt is successful. ### Updating Home Assistant Core #### Prerequisites 1. [Back up your installation](https://www.home-assistant.io/common-tasks/general/#backups) and store the backup and the [backup emergency kit](https://www.home-assistant.io/more-info/backup-emergency-kit/) somewhere safe. - This ensures that you can [restore your installation from backup](https://www.home-assistant.io/common-tasks/general/#restoring-a-backup) if needed. 2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](https://www.home-assistant.io/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for Backward-incompatible changes. #### To update Home Assistant Core To update Home Assistant Core, choose one of the following options. Using the UIUsing the CLI 1. Open your Home Assistant UI. 2. Go to the Settings panel. 3. On the top you will be presented with an update notification. - Troubleshooting: If you do not see that notification: - In the top right corner, select the three dots menu and select Check for updates. - Go to [System \> Updates](https://my.home-assistant.io/redirect/updates). - Select the update notification. - Select the cogwheel , then set Visible to active. 1. Open the notification for the component you want to update. 2. If you want to backup the system first (recommended), enable the backup toggle. 3. Select Update. 4. After the update completed, check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed. ``` ha core update --backup ``` The `--backup` flag here ensures that you have a partial backup of your current setup in case you need to downgrade. ## Network storage You can configure both Network File System (NFS) and Samba/Windows (CIFS) targets to be used within Home Assistant and apps. To list all your currently connected network storages, go to [Settings \> System \> Storage](https://my.home-assistant.io/redirect/storage) in the UI. Important You need to update to Home Assistant Operating System 10.2 before you can use this feature. ![](https://www.home-assistant.io/images/screenshots/network-storage/list_light.png) Screenshot of the list of network shares inside the storage panel. ### Add a new network storage 1. Go to [Settings \> System \> Storage](https://my.home-assistant.io/redirect/storage) in the UI. 2. Select Add network storage. 3. Fill out all the information for your network storage. 4. Select Connect. ![](https://www.home-assistant.io/images/screenshots/network-storage/connect_light.png) Screenshot of connecting a new network storage. #### Network storage configuration Name This is the name that will be used for the mounted directory on your system. Usage Here, you select how the target should be used. [See usage types below](https://www.home-assistant.io/common-tasks/os/#usage-types) Server The IP/hostname of the server running NFS/CIFS. Protocol3 The service the server is using for the network storage. \[NFS\]1 Remote share path The path used to connect to the remote storage server. \[CIFS\]2 Username The username to use when connecting to the storage server. Use User Principal Name for domain accounts. For example: `[email protected]`. \[CIFS\]2 Password The password to use when connecting to the storage server. \[CIFS\]2 Share The share to connect to on the storage server. 1 Options prefixed with `[NFS]` are only available for NFS targets. 2 Options prefixed with `[CIFS]` are only available for CIFS targets. 3 For the `CIFS` option, only version 2.1+ is supported. ##### Usage types Backup This will become a target. You can use it when creating an automatic or manual backup. The first storage you add of this type becomes your new default target. If you want to change the default target, [check out the documentation below](https://www.home-assistant.io/common-tasks/os/#change-default-local-backup-location). Media A new directory with the name you gave your network storage will be created under `/media`. This directory can be accessed by Home Assistant and apps. Share A new directory with the name you gave your network storage will be created under `/share`. This directory can be accessed by Home Assistant and apps. ### Change default local backup location By default, the first network storage of type Backup that you add is used as your local default backup location. If you want to change the local network storage that is used to store your backups, follow these steps: 1. Go to [Settings \> System \> Backups](https://my.home-assistant.io/redirect/backup). 2. Select Settings and history. 3. In the top-right corner, select the three dots menu and select Change default action location. 4. Select your preferred network location and save your changes. ![Select default location used for local backup](https://www.home-assistant.io/images/screenshots/network-storage/backup_select_local_default.png) 5. Troubleshooting: Don’t see your external storage location? This list contains only the network storage targets you have added of type Backup. ## Lost Password and password reset Please refer to the [I’m locked out\!](https://www.home-assistant.io/docs/locked_out/) documentation page. ## Installing a third-party app repository Home Assistant allows anyone to create an app repository to share their own apps with the community. Warning Home Assistant cannot guarantee the quality or security of third-party apps. Use at your own risk. To add an app repository, follow these steps: 1. Copy the URL of the repository. - The URL is the git repository clone URL (on GitHub, use the Code button and copy the HTTPS URL). - This documentation uses an example app repository. It is not practically useful but follows the same steps. - If you are interested in app development, refer to our [Home Assistant app development documentation](https://developers.home-assistant.io/docs/apps/). ``` https://github.com/home-assistant/hassio-addons-example ``` 2. Go to [Settings \> Apps](https://my.home-assistant.io/redirect/supervisor) and select App store. ![Screenshot of the Home Assistant app store](https://www.home-assistant.io/images/getting-started/app-store.png) 3. In the top-right corner, select the three dots menu, and select Repositories. 4. Add the URL of the repository and select Add. ![Screenshot of the app store](https://www.home-assistant.io/images/getting-started/adding_repositories-url.png) - Result: A new card for the third-party repository will appear. ![Screenshot of the app store](https://www.home-assistant.io/images/getting-started/add-ons-community_example.png) ### Troubleshooting: Repository is not showing up If you have added an app repository, but it’s not showing up, make sure to refresh your browser. If it still doesn’t show up, the app repository may contain invalid configuration data. 1. Go to [Settings \> System \> Logs](https://my.home-assistant.io/redirect/logs) and select Supervisor in the top right corner to get the Supervisor log. - It should tell you what went wrong. 2. Report this information to the app repository author. ## Configuration check After changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core. ### Running a configuration check from the UI 1. Go to [your user profile](https://my.home-assistant.io/redirect/profile) and enable Advanced Mode. 2. Go to [Settings \> Developer tools \> YAML](https://my.home-assistant.io/redirect/server_controls) and in the Configuration validation section, select the Check configuration button. - This is to make sure there are no syntax errors before restarting Home Assistant. - It checks for valid YAMLYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the `configuration.yaml` or `automations.yaml` files. [\[Learn more\]](https://www.home-assistant.io/docs/configuration/yaml/) and valid config structures. 3. If you need to do a more comprehensive configuration check, [run the check from the CLI](https://www.home-assistant.io/common-tasks/os/#to-run-a-configuration-check-from-the-cli). ### Running a configuration check from the CLI Use the following command to check if the configuration is valid. The command line configuration check validates the YAMLYAML is a human-readable data serialization language. It is used to store and transmit data in a structured format. In Home Assistant, YAML is used for configuration, for example in the `configuration.yaml` or `automations.yaml` files. [\[Learn more\]](https://www.home-assistant.io/docs/configuration/yaml/) files and checks for valid config structures, as well as some other elements. ``` ha core check ``` ## Home Assistant versions To see which version your system is running, go to [Settings \> About](https://my.home-assistant.io/redirect/info). ### Feature preview If you want to preview upcoming features, you can enable preview under [Settings \> System \> Labs](https://my.home-assistant.io/redirect/labs). Labs allows you to preview selected features that are stable but are still being fine-tuned. Preview is different from installing a beta or development version, which are used for development and testing. For more information, refer to the [Labs documentation](https://www.home-assistant.io/integrations/labs). ### Running a beta version If you would like to test next release before anyone else, you can install the beta version. From the UIFrom the CLI 1. In Home Assistant, go to [System \> Updates](https://my.home-assistant.io/redirect/updates). 2. In the top-right corner, select the three dots menu. 3. Select Join beta. 4. Go to the [Configuration](https://my.home-assistant.io/redirect/configuration) panel. 5. Install the update that is presented to you. - Troubleshooting: If you do not see that notification: - In the top right corner, select the three dots menu and select Check for updates. - Go to [System \> Updates](https://my.home-assistant.io/redirect/updates). - Select the update notification. - Select the cogwheel , then set Visible to active. 1. Join the beta channel. ``` ha supervisor options --channel beta ``` 2. Reload Home Assistant Supervisor. ``` ha supervisor reload ``` 3. Update Home Assistant Core to the latest beta version. ``` ha core update --backup ``` The `--backup` flag here ensures that you have a partial backup of your current setup in case you need to downgrade. ### Running a development version If you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to `dev`. Caution The `dev` branch is likely to be unstable. Potential consequences include loss of data and instance corruption. 1. Join the dev channel. ``` ha supervisor options --channel dev ``` 2. Reload the Home Assistant SupervisorThe Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, apps, itself, and, if used, updating the Home Assistant Operating System.. ``` ha supervisor reload ``` 3. Update Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated. to the latest dev version. ``` ha core update --backup ``` The `--backup` flag here ensures that you have a partial backup of your current setup incase you need to downgrade. ### Running a specific version To upgrade to a specific version, you can use the command line (CLI). The example below shows how to upgrade to `2026.4.1`. To learn how to get started with the command line in Home Assistant, refer to the [SSH app setup instructions](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-ssh-app). ``` ha core update --version 2026.4.1 --backup ``` The `--backup` flag here ensures that you have a partial backup of your current setup in case you need to downgrade later. To downgrade your installation, do a [partial restore of a backup](https://www.home-assistant.io/common-tasks/general/#backups) instead. ## Using external data disk Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. supports storing data on a secondary storage medium. For example, this can be a second internal SSD or HDD or a USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster. ![Graphics showing the architecture of the data disk feature](https://www.home-assistant.io/images/haos/usb-data-disk.png) The data disk feature can be used on an existing installation without losing data: The system will move existing data to the external data disk automatically. However, it is recommended to create and download a full [Backup](https://www.home-assistant.io/common-tasks/os/#backups) before proceeding\! Caution All data on the target disk will be overwritten\! Important The storage capacity of the external data disk must be larger than the storage capacity of the existing (boot) disk. Important If you have been using a data disk previously with Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., you need to use your host computer to delete all partitions before using it as a data disk again. ### Using UI to move the data partition 1. Connect the data disk to your system. 2. Go to [Settings \> System \> Storage](https://my.home-assistant.io/redirect/storage) in the UI. 3. Select Move data disk. 4. Select the data disk from the list of available devices. 5. Select Move. - Depending on the amount of data, this may take a while. ### Using CLI to move the data partition To see the current data disk use: ``` $ ha os info ... data_disk: /dev/mmcblk1p4 ... ``` To get a list of potential targets which can be used by `datadisk`: ``` ha os datadisk list ``` To initiate the move to the new data disk use the `move` command: ``` ha os datadisk move /dev/sdx ``` The system will prepare the data disk and immediately reboot. The reboot will take 10 minutes or more depending on the speed of the new data disk; please be patient\! Warning Using an USB attached SSD can draw quite some power. For instance on Raspberry Pi 3 the official Raspberry Pi power supply (PSU) only provides 2.5A which can be too tight. Use a more powerful power supply if you experience issues. Alternatively use a powered USB hub. Connect the Hub to one of the USB slots of your Raspberry Pi, and connect the SSD to the Hub. In this setup the power supply of the Hub will power the attached device(s). ### Migrating an external data disk to another system This section shows how to move an external data disk from one system to another. This can be an option if the following elements apply to your use case: - You already have a functioning Home Assistant instance (system 1) that is using an external data disk. - You have another, new, Home Assistant instance (system 2). - You now want to use the data disk of system 1 on system 2 instead. The aim is to migrate the data from system 1 to system 2. One way to do this is by [restoring a backup](https://www.home-assistant.io/common-tasks/general/#restoring-a-backup). The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk or if your external disk has more storage capacity than your new system. #### Prerequisites - A Home Assistant instance using an external data disk (system 1) - A Home Assistant instance to which you want to move the external data disk (system 2) #### To migrate an external data disk to another system To migrate an external data disk from one system to another, follow these steps: 1. [Create a backup](https://www.home-assistant.io/common-tasks/general/#backups) of both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data). 2. Shut down system 1 and remove the data disk. 3. Make sure system 2 has Home Assistant OS installed, and Home Assistant is up and running. Home Assistant is using the data disk (partition) on the boot drive (e.g. SD card) at this point. 4. Make sure system 2 has completed the basic [onboarding](https://www.home-assistant.io/getting-started/onboarding/) steps, including the last steps where devices are discovered automatically. 5. Plug the external disk into system 2 and go to the Settings \> System. Select the three dots menu, and Restart Home Assistant \> Reboot system. Result: A repair issue is displayed Multiple data disks detected. - The repair issue comes up because system 2 now sees two file systems with an identical name. During a reboot, there is a name conflict with the existing data disk as it is undefined which file system should be used. This can lead to a random selection of the system you end up with. Hence you must make a decision. 6. Open the repair issue and choose one of the options: - Select Use the detected data disk instead of the current system. - This will override the current file system of system 2 and use your external data disk instead. - You won’t have access anymore to the current Home Assistant data. It will be marked as inactive data disk. - If you changed your mind about using the external data disk: - Unplug the external data disk. - If you cannot unplug the external data disk for some reason, select Mark as inactive data disk (rename file system). - This makes sure that there is no name conflict after rebooting. - It also means you cannot use the file system that is stored on your external disk. - You keep using the current file system of system 1. ## Home Assistant via the command line On the [SSH command line](https://www.home-assistant.io/common-tasks/os/), you can use the `ha` command to retrieve logs, check the details of connected hardware, and more. ### Home Assistant ``` ha core check ha core info ha core logs ha core options ha core rebuild ha core restart ha core restart --safe-mode ha core start ha core stats ha core stop ha core update ``` ### Supervisor ``` ha supervisor info ha supervisor logs ha supervisor reload ha supervisor update ``` ### Host ``` ha host reboot ha host shutdown ha host update ``` ### Hardware ``` ha hardware info ha hardware audio ``` ### Usage examples To update Home Assistant to a specific version, use the command: ``` ha core update --version x.y.z ``` Replace x.y.z with the desired version like `--version 2026.4.1` You can get a better description of the CLI capabilities by typing `ha help`: ``` The Home Assistant CLI is a small and simple command line utility that allows you to control and configure different aspects of Home Assistant Usage: ha [command] Available Commands: addons Install, update, remove and configure Home Assistant apps audio Audio device handling. authentication Authentication for Home Assistant users. backups Create, restore and remove backups banner Prints the CLI Home Assistant banner along with some useful information cli Get information, update or configure the Home Assistant cli backend core Provides control of the Home Assistant Core dns Get information, update or configure the Home Assistant DNS server docker Docker backend specific for info and OCI configuration hardware Provides hardware information about your system help Help about any command host Control the host/system that Home Assistant is running on info Provides a general Home Assistant information overview jobs Get information and manage running jobs multicast Get information, update or configure the Home Assistant Multicast network Network specific for updating, info and configuration imports observer Get information, update or configure the Home Assistant observer os Operating System specific for updating, info and configuration imports resolution Resolution center of Supervisor, show issues and suggest solutions supervisor Monitor, control and configure the Home Assistant Supervisor Flags: --api-token string Home Assistant Supervisor API token --config string Optional config file (default is $HOME/.homeassistant.yaml) --endpoint string Endpoint for Home Assistant Supervisor (default is 'supervisor') -h, --help help for ha --log-level string Log level (defaults to Warn) --no-progress Disable the progress spinner --raw-json Output raw JSON from the API Use "ha [command] --help" for more information about a command. ``` ### Console access You can also access the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. via a directly connected keyboard and monitor, the console. #### Wiping the data disk from the command line In Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., the `ha os datadisk wipe` command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed apps. The command `ha os datadisk wipe` marks the data partition (either internal on the eMMC or the SD card, or on an external attached data disk) as to be cleared on the next reboot. The command automatically reboots the system. Upon reboot, the data is cleared. Then the system continues to boot and reinstalls the latest version of all Home Assistant components. The `ha os datadisk wipe` command can only be run from the local terminal. Connect a display and keyboard and use the terminal. Note, some systems have a reset button you can use to clear the data disk, instead of using the command line: - If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 5, use the command line steps described above. - If you have a Home Assistant Yellow with a Raspberry Pi Compute Module 4, there is a red hardware button to wipe the data disk. Follow the procedure on [resetting the Home Assistant Yellow](https://support.nabucasa.com/hc/articles/25463622043165). - If you have a Home Assistant Green, there is a black hardware button to wipe the data disk. Follow the procedure on [resetting the Home Assistant Green](https://support.nabucasa.com/hc/en-us/articles/25161225495837). #### Listing all users from the command line In Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users., the `ha auth list` command lists all users that are registered on your Home Assistant. The `ha auth list` command can only be run from the local terminal. Connect a display and keyboard and use the terminal. ## Enable duplicate log file By default, Home Assistant Core logs are sent to the Systemd Journal, which can be read using the [`ha core logs` command](https://www.home-assistant.io/common-tasks/os/#home-assistant-via-the-command-line). If you need logs to also be written to a file (`/config/home-assistant.log`), you can enable the duplicated log file option using the [command line](https://www.home-assistant.io/common-tasks/os/#home-assistant-via-the-command-line): ``` ha core options --duplicate-log-file=true ha core rebuild ha core restart ``` To disable it: ``` ha core options --duplicate-log-file=false ha core rebuild ha core restart ``` ## Enable I2C Home Assistant using the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. which is a managed environment, which means you can’t use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to - Enable I2C for the Home Assistant Operating System - Setup I2C devices e.g. sensors ### Enable I2C with an SD card reader #### Access the boot partition You will need: - SD card reader - SD card with Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. flashed on it Shutdown/turn-off your Home Assistant installation and unplug the SD card. Plug the SD card into an SD card reader and find a drive/file system named `hassos-boot`. The file system might be shown/mounted automatically. If not, use your operating systems disk management utility to find the SD card reader and make sure the first partition is available. #### Add files to enable I2C - In the root of the `hassos-boot` partition, add a new folder called `CONFIG`. - In the `CONFIG` folder, add another new folder called `modules`. - Inside the `modules` folder add a text file called `rpi-i2c.conf` with the following content: ``` i2c-dev ``` - In the root of the `hassos-boot` partition, edit the file called `config.txt` add two lines to it: ``` dtparam=i2c_vc=on dtparam=i2c_arm=on ``` #### Start with the new OS configuration - Insert the SD card back into your Raspberry Pi. - On startup, the `hassos-config.service` will automatically pickup the new `rpi-i2c.conf` configuration. - Another reboot might be necessary to make sure the just imported `rpi-i2c.conf` is present at boot time. ### Enable I2C via Home Assistant Operating System Terminal Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.. You can enable I2C via this terminal: - Login as `root`. - Type `login` and press enter to access the shell: ``` mkdir -p /mnt/boot/CONFIG/modules echo i2c-dev > /mnt/boot/CONFIG/modules/rpi-i2c.conf echo dtparam=i2c_vc=on >> /mnt/boot/config.txt echo dtparam=i2c_arm=on >> /mnt/boot/config.txt sync reboot ``` ### Troubleshooting After rebooting the host there should be `i2c-0` and similar device files in `/dev`. If such device files are missing, enabling I2C failed for some reason. You can check the status of I2C kernel modules by using `lsmod \| grep i2c` in the terminal. If they are loaded, you should find at least the entry `i2c_dev`. Active usage of the modules is indicated by a number, e.g. `i2c_dev 20480 2` would indicate two active I2C device files. An active I2C can also be checked with a multi meter showing 3.3 V on the I2C pins GPIO2 and GPIO3. #### Help us improve our documentation Suggest an edit to this page, or provide/view feedback for this page. - [Edit](https://github.com/home-assistant/home-assistant.io/tree/current/source/common-tasks/os.markdown "Edit this page") - [Provide feedback](https://github.com/home-assistant/home-assistant.io/issues/new?template=feedback.yml&url=https%3A%2F%2Fwww.home-assistant.io%2Fcommon-tasks%2Fos%2F&version=2026.4.1&labels=current "Provide feedback on this page") - [View given feedback](https://github.com/home-assistant/home-assistant.io/issues?utf8=%E2%9C%93&q=%22%2Fcommon-tasks%2Fos%2F%22&in=body "View given feedback for this page")
Shard	77 (laksa)
Root Hash	6959518072785130877
Unparsed URL	io,home-assistant!www,/common-tasks/os/ s443