Site updated at 2018-01-31 08:54:26 UTC

This commit is contained in:
Travis CI 2018-01-31 08:54:26 +00:00
parent fa9726dc17
commit e2f22f5b73
178 changed files with 3665 additions and 369 deletions

View file

@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en-US">
<meta charset="utf-8">
<title>Redirecting…</title>
<link rel="canonical" href="https://home-assistant.io/docs/tools/keyring/">
<meta http-equiv="refresh" content="0; url=https://home-assistant.io/docs/tools/keyring/">
<h1>Redirecting…</h1>
<a href="https://home-assistant.io/docs/tools/keyring/">Click here if you are not redirected.</a>
<script>location="https://home-assistant.io/docs/tools/keyring/"</script>
</html>

View file

@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en-US">
<meta charset="utf-8">
<title>Redirecting…</title>
<link rel="canonical" href="https://home-assistant.io/docs/tools/credstash/">
<meta http-equiv="refresh" content="0; url=https://home-assistant.io/docs/tools/credstash/">
<h1>Redirecting…</h1>
<a href="https://home-assistant.io/docs/tools/credstash/">Click here if you are not redirected.</a>
<script>location="https://home-assistant.io/docs/tools/credstash/"</script>
</html>

View file

@ -105,49 +105,16 @@
</code></pre>
</div>
<p>This will not print the actual secrets value to the log.</p>
<p><em>Option 2</em>: View where secrets are retrieved from and the contents of all <code class="highlighter-rouge">secrets.yaml</code> files used, you can use the <code class="highlighter-rouge">check_config</code> script from the command line:</p>
<p><em>Option 2</em>: View where secrets are retrieved from and the contents of all <code class="highlighter-rouge">secrets.yaml</code> files used, you can use the <a href="/docs/tools/check_config/"><code class="highlighter-rouge">check_config</code> script</a> from the command line:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass --script check_config --secrets
</code></pre>
</div>
<p>This will print all your secrets.</p>
<h3><a class="title-link" name="storing-passwords-in-a-keyring-managed-by-your-os" href="#storing-passwords-in-a-keyring-managed-by-your-os"></a> Storing passwords in a keyring managed by your OS</h3>
<p>Using <a href="https://github.com/jaraco/keyring">Keyring</a> is an alternative way to <code class="highlighter-rouge">secrets.yaml</code>. They can be managed from the command line via the <code class="highlighter-rouge">keyring</code> script.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass --script keyring --help
</code></pre>
</div>
<p>To store a password in keyring, replace your password or API key with <code class="highlighter-rouge">!secret</code> and an identifier in <code class="highlighter-rouge">configuration.yaml</code> file.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">http</span><span class="pi">:</span>
<span class="s">api_password</span><span class="pi">:</span> <span class="kt">!secret</span> <span class="s">http_password</span>
</code></pre>
</div>
<p>Create an entry in your keyring.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass --script keyring <span class="nb">set </span>http_password
</code></pre>
</div>
<p>If you launch Home Assistant now, you will be prompted for the keyring password to unlock your keyring.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass
Config directory: /home/homeassistant/.homeassistant
Please enter password <span class="k">for </span>encrypted keyring:
</code></pre>
</div>
<p class="note warning">
If you are using the Python Keyring, <a href="/getting-started/autostart/">autostarting</a> of Home Assistant will no longer work.
</p>
<h3><a class="title-link" name="storing-passwords-securely-in-aws" href="#storing-passwords-securely-in-aws"></a> Storing passwords securely in AWS</h3>
<p>Using <a href="https://github.com/fugue/credstash">Credstash</a> is an alternative way to <code class="highlighter-rouge">secrets.yaml</code>. They can be managed from the command line via the credstash script.</p>
<p>Before using credstash, you need to set up AWS credentials either via the <code class="highlighter-rouge">aws</code> command line tool or using environment variables as explained in the <a href="http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html">AWS CLI docs</a> as well as creating a KMS key named <code class="highlighter-rouge">credstash</code> as explained in the <a href="https://github.com/fugue/credstash#setting-up-kms">credstash Readme</a>. After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass --script credstash --help
</code></pre>
</div>
<p>To store a password in credstash, replace your password or API key with <code class="highlighter-rouge">!secret</code> and an identifier in <code class="highlighter-rouge">configuration.yaml</code> file.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">http</span><span class="pi">:</span>
<span class="s">api_password</span><span class="pi">:</span> <span class="kt">!secret</span> <span class="s">http_password</span>
</code></pre>
</div>
<p>Create an entry in your credstash store.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>hass --script credstash <span class="nb">set </span>http_password
</code></pre>
</div>
<h2><a class="title-link" name="alternatives-to-secretsyaml" href="#alternatives-to-secretsyaml"></a> Alternatives to <code class="highlighter-rouge">secrets.yaml</code></h2>
<ul>
<li><a href="/docs/tools/keyring/">Using a keyring that is managed by your OS to store secrets</a></li>
<li><a href="/docs/tools/credstash/">Storing passwords securely in AWS</a></li>
</ul>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
@ -241,7 +208,13 @@ Please enter password <span class="k">for </span>encrypted keyring:
<ul>
<li><a href='/docs/tools/dev-tools/'>Developer Tools </a></li>
<li><a href='/docs/tools/hass/'>hass </a></li>
<li><a href='/docs/tools/scripts/'>Scripts </a></li>
<li><a href='/docs/tools/benchmark/'>benchmark </a></li>
<li><a href='/docs/tools/check_config/'>check_config </a></li>
<li><a href='/docs/tools/credstash/'>credstash </a></li>
<li><a href='/docs/tools/db_migrator/'>db_migrator </a></li>
<li><a href='/docs/tools/ensure_config/'>ensure_config </a></li>
<li><a href='/docs/tools/influxdb_import/'>influxdb_import </a></li>
<li><a href='/docs/tools/keyring/'>keyring </a></li>
</ul>
</li>
<li>