From 5e53074280d216af8c2a807d576565a848eaa300 Mon Sep 17 00:00:00 2001 From: cogneato Date: Thu, 13 Feb 2020 15:01:55 -0700 Subject: [PATCH 1/8] Adds locked_out.md Adds documentation for options when locked out or needing to recover files --- source/_docs/locked_out.md | 62 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 source/_docs/locked_out.md diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md new file mode 100644 index 000000000000..5410b8035fd3 --- /dev/null +++ b/source/_docs/locked_out.md @@ -0,0 +1,62 @@ +# I'm locked out! + +The sections below deal with recovering from a situation where you are not able to sign in, +or need to recover your data. + + +## Forgot Password + +### Home Assistant Core users: + +While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/): + * auth + * auth_provider.homeassistant + * onboarding + * hassio + * cloud + +### Home Assistant Supervised users: + +If you’ve forgotten your user, then the deleting the files mentioned above will be necessary to start a new onboarding process. + +If you know the user, but not the password and you can access the [Home Assistant Console](https://www.home-assistant.io/hassio/commandline/) and use the command below: +Connect a keyboard and monitor to your device. +`ha auth reset --username --password ` + + +## Recovering Data for Home Assistant Supervised users: + +Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further. +There are a few routes: + +* Connect a usb keyboard and hdmi monitor directly to the pi + +* Remove the SD and access the files from another machine (preferably one running Linux) + +## Connect directly + +If you’re using a pi, you're likely going to have to pull the power in order to get your monitor recognized at boot. Pulling power has a risk of corrupting the SD, but you may not have another option. Most standard USB keyboards should be recognized easily. + +Once you're connected you'll see a running dmesg log. Hit the enter key to interrupt the log. +Sign in as "root". There is no password. + +You will then be at the Hassio CLI where you can run the Home Assistant custom commands. These are the same you would run using the ssh addon but without using "ha" in front. For example: + +* `core logs` for homeassistant core log +* `supervisor logs` for supervisor logs +* `host reboot` to reboot the host +* `dns logs` for checking dns +* etc (typing `help` will show more) + + +##Accessing Files from the SD/HDD + +### Remove the SD and access the files from another computer + +The files are on an EXT4 partition (hassos-data) and the path is /mnt/data/supervisor. +These are easily accessed using another linux machine with EXT support. + +For Windows or OS X you will need third party software. Below are some options. + +* Windows: https://www.diskinternals.com/linux-reader/ (read only access to the SD) +* Mac: https://osxfuse.github.io/ From 03fec50db9d0ad110454584f1c7c9dbadbecea3c Mon Sep 17 00:00:00 2001 From: cogneato Date: Thu, 13 Feb 2020 15:25:20 -0700 Subject: [PATCH 2/8] Adds meta data --- source/_docs/locked_out.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 5410b8035fd3..ebfed49368c7 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -1,3 +1,8 @@ +--- +title: "I'm Locked Out!" +description: "Options for regaining access" +--- + # I'm locked out! The sections below deal with recovering from a situation where you are not able to sign in, From 959db0a0f1f7b774e031411de95fffc2b7db1071 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 13 Feb 2020 23:58:05 +0100 Subject: [PATCH 3/8] :pencil2: Tweak --- source/_docs/locked_out.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index ebfed49368c7..28547848ac7a 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -8,7 +8,6 @@ description: "Options for regaining access" The sections below deal with recovering from a situation where you are not able to sign in, or need to recover your data. - ## Forgot Password ### Home Assistant Core users: @@ -28,7 +27,6 @@ If you know the user, but not the password and you can access the [Home Assistan Connect a keyboard and monitor to your device. `ha auth reset --username --password ` - ## Recovering Data for Home Assistant Supervised users: Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further. @@ -53,8 +51,7 @@ You will then be at the Hassio CLI where you can run the Home Assistant custom c * `dns logs` for checking dns * etc (typing `help` will show more) - -##Accessing Files from the SD/HDD +## Accessing Files from the SD/HDD ### Remove the SD and access the files from another computer From b647b50f615faaeaa48914c93f3c51c46f07b9d2 Mon Sep 17 00:00:00 2001 From: cogneato Date: Thu, 13 Feb 2020 16:52:44 -0700 Subject: [PATCH 4/8] fix incorrect terms --- source/_docs/locked_out.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 28547848ac7a..39e10e17b2d2 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -43,12 +43,12 @@ If you’re using a pi, you're likely going to have to pull the power in order t Once you're connected you'll see a running dmesg log. Hit the enter key to interrupt the log. Sign in as "root". There is no password. -You will then be at the Hassio CLI where you can run the Home Assistant custom commands. These are the same you would run using the ssh addon but without using "ha" in front. For example: +You will then be at the Home ASsistant CLI where you can run the custom commands. These are the same you would run using the ssh addon but without using "ha" in front. For example: -* `core logs` for homeassistant core log +* `core logs` for Home Assistant Core log * `supervisor logs` for supervisor logs * `host reboot` to reboot the host -* `dns logs` for checking dns +* `dns logs` for checking DNS * etc (typing `help` will show more) ## Accessing Files from the SD/HDD @@ -56,9 +56,9 @@ You will then be at the Hassio CLI where you can run the Home Assistant custom c ### Remove the SD and access the files from another computer The files are on an EXT4 partition (hassos-data) and the path is /mnt/data/supervisor. -These are easily accessed using another linux machine with EXT support. +These are easily accessed using another Linux machine with EXT support. -For Windows or OS X you will need third party software. Below are some options. +For Windows or macOS you will need third party software. Below are some options. * Windows: https://www.diskinternals.com/linux-reader/ (read only access to the SD) * Mac: https://osxfuse.github.io/ From d43f62afd7b90be37311f09187d9a0516d0b0313 Mon Sep 17 00:00:00 2001 From: cogneato Date: Thu, 13 Feb 2020 16:54:45 -0700 Subject: [PATCH 5/8] fix typo --- source/_docs/locked_out.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 39e10e17b2d2..5b9284e5cc94 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -43,7 +43,7 @@ If you’re using a pi, you're likely going to have to pull the power in order t Once you're connected you'll see a running dmesg log. Hit the enter key to interrupt the log. Sign in as "root". There is no password. -You will then be at the Home ASsistant CLI where you can run the custom commands. These are the same you would run using the ssh addon but without using "ha" in front. For example: +You will then be at the Home Assistant CLI where you can run the custom commands. These are the same you would run using the ssh addon but without using "ha" in front. For example: * `core logs` for Home Assistant Core log * `supervisor logs` for supervisor logs From 8be452b568b02e01ac4feac8899c332efd8bb7bf Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 14 Feb 2020 09:35:11 +0100 Subject: [PATCH 6/8] :pencil2: Tweaks --- source/_docs/locked_out.md | 43 ++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 5b9284e5cc94..40b291549d04 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -10,40 +10,43 @@ or need to recover your data. ## Forgot Password -### Home Assistant Core users: +### Home Assistant (including Supervised) -While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/): - * auth - * auth_provider.homeassistant - * onboarding - * hassio - * cloud - -### Home Assistant Supervised users: +If you’ve forgotten your user, then deleting the files mentioned above will be necessary to start a new onboarding process. -If you’ve forgotten your user, then the deleting the files mentioned above will be necessary to start a new onboarding process. +If you know the user, but not the password and you can access the [Home Assistant console](https://www.home-assistant.io/hassio/commandline/) and use the command below: -If you know the user, but not the password and you can access the [Home Assistant Console](https://www.home-assistant.io/hassio/commandline/) and use the command below: Connect a keyboard and monitor to your device. -`ha auth reset --username --password ` -## Recovering Data for Home Assistant Supervised users: +`ha auth reset --username "" --password ""` + +### Home Assistant Core + +While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/): + +- `auth` +- `auth_provider.homeassistant` +- `onboarding` +- `hassio` +- `cloud` + +## Recovering Data for Home Assistant (including Supervised) Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further. There are a few routes: -* Connect a usb keyboard and hdmi monitor directly to the pi +* Connect a USB keyboard and HDMI monitor directly to the pi * Remove the SD and access the files from another machine (preferably one running Linux) ## Connect directly -If you’re using a pi, you're likely going to have to pull the power in order to get your monitor recognized at boot. Pulling power has a risk of corrupting the SD, but you may not have another option. Most standard USB keyboards should be recognized easily. +If you’re using a Raspberry Pi, you're likely going to have to pull the power in order to get your monitor recognized at boot. Pulling power has a risk of corrupting the SD, but you may not have another option. Most standard USB keyboards should be recognized easily. -Once you're connected you'll see a running dmesg log. Hit the enter key to interrupt the log. +Once you're connected, you'll see a running dmesg log. Hit the enter key to interrupt the log. Sign in as "root". There is no password. -You will then be at the Home Assistant CLI where you can run the custom commands. These are the same you would run using the ssh addon but without using "ha" in front. For example: +You will then be at the Home Assistant CLI, where you can run the custom commands. These are the same as you would run using the SSH addon but without using `ha` in front of it. For example: * `core logs` for Home Assistant Core log * `supervisor logs` for supervisor logs @@ -55,10 +58,10 @@ You will then be at the Home Assistant CLI where you can run the custom commands ### Remove the SD and access the files from another computer -The files are on an EXT4 partition (hassos-data) and the path is /mnt/data/supervisor. +The files are on an EXT4 partition (`hassos-data`) and the path is `/mnt/data/supervisor`. These are easily accessed using another Linux machine with EXT support. For Windows or macOS you will need third party software. Below are some options. -* Windows: https://www.diskinternals.com/linux-reader/ (read only access to the SD) -* Mac: https://osxfuse.github.io/ +- Windows: https://www.diskinternals.com/linux-reader/ (read-only access to the SD) +- Mac: https://osxfuse.github.io/ From af7f357bc82970dca3ce335593327f90f58f2290 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 14 Feb 2020 09:35:49 +0100 Subject: [PATCH 7/8] :pencil2: Tweak --- source/_docs/locked_out.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 40b291549d04..66e5ff3a190e 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -3,8 +3,6 @@ title: "I'm Locked Out!" description: "Options for regaining access" --- -# I'm locked out! - The sections below deal with recovering from a situation where you are not able to sign in, or need to recover your data. From 985e96f6f58daacf75fbd404ea07dfb95ae69705 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 14 Feb 2020 09:36:58 +0100 Subject: [PATCH 8/8] :pencil2: Tweaks --- source/_docs/locked_out.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 66e5ff3a190e..051e01bf04d8 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -33,9 +33,8 @@ While you should hopefully be storing your passwords in a password manager, if y Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further. There are a few routes: -* Connect a USB keyboard and HDMI monitor directly to the pi - -* Remove the SD and access the files from another machine (preferably one running Linux) +- Connect a USB keyboard and HDMI monitor directly to the Raspberry Pi. +- Remove the SD and access the files from another machine (preferably one running Linux). ## Connect directly @@ -46,11 +45,11 @@ Sign in as "root". There is no password. You will then be at the Home Assistant CLI, where you can run the custom commands. These are the same as you would run using the SSH addon but without using `ha` in front of it. For example: -* `core logs` for Home Assistant Core log -* `supervisor logs` for supervisor logs -* `host reboot` to reboot the host -* `dns logs` for checking DNS -* etc (typing `help` will show more) +- `core logs` for Home Assistant Core log +- `supervisor logs` for supervisor logs +- `host reboot` to reboot the host +- `dns logs` for checking DNS +- etc (typing `help` will show more) ## Accessing Files from the SD/HDD