From ab97f9595173120d4a15b5f0cd6f100841b23793 Mon Sep 17 00:00:00 2001 From: Hmmbob <33529490+hmmbob@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:44:20 +0100 Subject: [PATCH] Remove docs for removed keyring/credstash options (#16745) --- source/_docs/configuration/secrets.markdown | 8 +--- source/_docs/tools/credstash.markdown | 35 ------------------ source/_docs/tools/keyring.markdown | 39 -------------------- source/_includes/asides/docs_navigation.html | 2 - source/_redirects | 2 + 5 files changed, 3 insertions(+), 83 deletions(-) delete mode 100644 source/_docs/tools/credstash.markdown delete mode 100644 source/_docs/tools/keyring.markdown diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index 23a68d3c837..8dec4f4c6c5 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. @@ -58,8 +57,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/) diff --git a/source/_docs/tools/credstash.markdown b/source/_docs/tools/credstash.markdown deleted file mode 100644 index 5560cd7d39e..00000000000 --- 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 -``` diff --git a/source/_docs/tools/keyring.markdown b/source/_docs/tools/keyring.markdown deleted file mode 100644 index c146440ae20..00000000000 --- 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: -``` - -