From 4b59a565f9608d07b1dbf3927c0df089070ac443 Mon Sep 17 00:00:00 2001 From: Hmmbob <33529490+hmmbob@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:28:50 +0100 Subject: [PATCH 1/6] Delete credstash.markdown --- source/_docs/tools/credstash.markdown | 35 --------------------------- 1 file changed, 35 deletions(-) delete mode 100644 source/_docs/tools/credstash.markdown diff --git a/source/_docs/tools/credstash.markdown b/source/_docs/tools/credstash.markdown deleted file mode 100644 index 5560cd7d39e6..000000000000 --- a/source/_docs/tools/credstash.markdown +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "credstash" -description: "Script to store credentials securely in AWS" ---- - -

-This feature has been deprecated and will be removed in March 2021. -

- -Using [Credstash](https://github.com/fugue/credstash) is an alternative way to `secrets.yaml`. They can be managed from the command line via the credstash script. - -Before using credstash, you need to set up AWS credentials either via the `aws` command line tool or using environment variables as explained in the [AWS CLI documentation](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named `credstash` as explained in the [credstash Readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash. - -```bash -hass --script credstash --help -``` - -To store a password in credstash, replace your password or API key with `!secret` and an identifier in `configuration.yaml` file. - -```yaml -example: - password: !secret example_password -``` - -Create an entry in your credstash store. - -```bash -hass --script credstash put http_password 123 -``` - -List your secrets. - -```bash -hass --script credstash list -``` From b4407a98f536fb9288e41fde35cbefe7e518ba3d Mon Sep 17 00:00:00 2001 From: Hmmbob <33529490+hmmbob@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:29:32 +0100 Subject: [PATCH 2/6] Delete keyring.markdown --- source/_docs/tools/keyring.markdown | 39 ----------------------------- 1 file changed, 39 deletions(-) delete mode 100644 source/_docs/tools/keyring.markdown diff --git a/source/_docs/tools/keyring.markdown b/source/_docs/tools/keyring.markdown deleted file mode 100644 index c146440ae20e..000000000000 --- a/source/_docs/tools/keyring.markdown +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "keyring" -description: "Script to store secrets in a keyring" ---- - -

-This feature has been deprecated and will be removed in March 2021. -

- -Using [Keyring](https://github.com/jaraco/keyring) is an alternative way to `secrets.yaml`. The secrets can be managed from the command line via the `keyring` script. - -```bash -hass --script keyring --help -``` - -To store a password in keyring, replace your password or API key with `!secret` and an identifier in `configuration.yaml` file. - -```yaml -integration1: - api_key: !secret integration1_key -``` - -Create an entry in your keyring. - -```bash -hass --script keyring set integration1_key -``` - -If you launch Home Assistant now, you will be prompted for the keyring password to unlock your keyring. - -```bash -$ hass -Config directory: /home/homeassistant/.homeassistant -Please enter password for encrypted keyring: -``` - -
-If you are using the Python Keyring, automatic starting of Home Assistant Core will no longer work. -
From becf87c0635b51ecfd25496a1b59911fb8eb5fc2 Mon Sep 17 00:00:00 2001 From: Hmmbob <33529490+hmmbob@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:30:25 +0100 Subject: [PATCH 3/6] Remove credstash and keyring links --- source/_docs/configuration/secrets.markdown | 5 ----- 1 file changed, 5 deletions(-) diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index 23a68d3c8377..499b97357326 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -58,8 +58,3 @@ hass --script check_config --secrets ``` This will print all your secrets. - -## Alternatives to `secrets.yaml` - -- [Using a keyring that is managed by your OS to store secrets](/docs/tools/keyring/) -- [Storing passwords securely in AWS](/docs/tools/credstash/) From 718407f6b030bf71c907d9316390fdaea16beeed Mon Sep 17 00:00:00 2001 From: Hmmbob <33529490+hmmbob@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:25:42 +0100 Subject: [PATCH 4/6] Removing keyring, credstash from sidebar --- source/_includes/asides/docs_navigation.html | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index 632e1dd44616..a7546728ac30 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -146,8 +146,6 @@

Topics

  • {% active_link /docs/tools/quick-bar/ Quick Bar %}
  • {% active_link /docs/tools/hass/ hass %}
  • {% active_link /docs/tools/check_config/ check_config %}
    • -
  • {% active_link /docs/tools/credstash/ credstash %}
    • -
  • {% active_link /docs/tools/keyring/ keyring %}
  • From df80f076a31034dd3e286f60b06e95c915b22d68 Mon Sep 17 00:00:00 2001 From: Hmmbob <33529490+hmmbob@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:31:08 +0100 Subject: [PATCH 5/6] Add keyring, credstash redirect --- source/_redirects | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_redirects b/source/_redirects index 89a69feb2195..f4bc0b59b4a5 100644 --- a/source/_redirects +++ b/source/_redirects @@ -2190,6 +2190,8 @@ /docs/installation/raspberry-pi-all-in-one /getting-started /getting-started/hassbian /getting-started /getting-started/installation-raspberry-pi-all-in-one /getting-started +/docs/tools/keyring/ /docs/configuration/secrets +/docs/tools/credstash/ /docs/configuration/secrets # Blog /blog/2019/05/29/release-94 /blog/2019/06/05/release-94 From 47a2a7dd4a85bf289b704238f13f7e38eff10d0f Mon Sep 17 00:00:00 2001 From: Hmmbob <33529490+hmmbob@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:39:59 +0100 Subject: [PATCH 6/6] Remove leftover keyring reference --- source/_docs/configuration/secrets.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index 499b97357326..8dec4f4c6c53 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -38,8 +38,7 @@ http_password: YOUR_PASSWORD When you start splitting your configuration into multiple files, you might end up with configuration in sub folders. Secrets will be resolved in this order: - A `secrets.yaml` located in the same folder as the YAML file referencing the secret, -- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main `configuration.yaml`, -- lastly, `keyring` will be queried for the secret (more info below). +- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main `configuration.yaml`. To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script.