Remove docs for removed keyring/credstash options (#16745)

This commit is contained in:
Hmmbob 2021-02-25 13:44:20 +01:00 committed by GitHub
parent c0b7a9b0a4
commit d1294d1b84
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 3 additions and 83 deletions

View File

@ -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/)

View File

@ -1,35 +0,0 @@
---
title: "credstash"
description: "Script to store credentials securely in AWS"
---
<p class='note warning'>
This feature has been deprecated and will be removed in March 2021.
</p>
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
```

View File

@ -1,39 +0,0 @@
---
title: "keyring"
description: "Script to store secrets in a keyring"
---
<p class='note warning'>
This feature has been deprecated and will be removed in March 2021.
</p>
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:
```
<div class='note warning'>
If you are using the Python Keyring, automatic starting of Home Assistant Core will no longer work.
</div>

View File

@ -146,8 +146,6 @@
<li>{% active_link /docs/tools/quick-bar/ Quick Bar %}</li>
<li>{% active_link /docs/tools/hass/ hass %}</li>
<li>{% active_link /docs/tools/check_config/ check_config %}</li>
<li>{% active_link /docs/tools/credstash/ credstash %}</li>
<li>{% active_link /docs/tools/keyring/ keyring %}</li>
</ul>
</li>
<li>

View File

@ -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