From d7224358e829c20c5eb86812c865c2490d47a1d9 Mon Sep 17 00:00:00 2001
From: Koen Hufkens <koen.hufkens@gmail.com>
Date: Mon, 13 Jul 2020 20:01:38 +0200
Subject: [PATCH] keyring docs

---
 README.md        | 11 +++++++++++
 docs/index.html  |  7 +++++++
 docs/pkgdown.yml |  2 +-
 3 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1f9f4ef..3868b40 100644
--- a/README.md
+++ b/README.md
@@ -321,6 +321,17 @@ file <- wf_request(user     = "2345",   # user ID (for authentification)
 
 The same file restrictions and notes as for the CDS apply to the ADS.
 
+## File based keychains
+
+On linux you can opt to use a file based keyring, instead of a GUI based keyring manager. This is helpful for headless setups such as servers. For this option to work linux users must set an environmental option.
+
+```R
+options(keyring_backend="file")
+```
+
+You will be asked to provide a password to encrypt the keyring with. Upon the start of each session you will be asked to provide this password, unlocking all `ecmwfr` credentials for this session. Should you ever forget the password just delete the file at: 
+`~/.config/r-keyring/ecmwfr.keyring` and re-enter all your credentials.
+
 ## Citation
 
 Koen Hufkens, Reto Stauffer, & Elio Campitelli. (2019, April 19). bluegreen-labs/ecmwfr: ecmwfr (Version v1.2.0). Zenodo. [http://doi.org/10.5281/zenodo.2647541](http://doi.org/10.5281/zenodo.2647541).
diff --git a/docs/index.html b/docs/index.html
index 81c1a5a..d47af46 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -330,6 +330,13 @@ <h3 class="hasAnchor">
 <p>The same file restrictions and notes as for the CDS apply to the ADS.</p>
 </div>
 </div>
+<div id="file-based-keychains" class="section level2">
+<h2 class="hasAnchor">
+<a href="#file-based-keychains" class="anchor"></a>File based keychains</h2>
+<p>On linux you can opt to use a file based keyring, instead of a GUI based keyring manager. This is helpful for headless setups such as servers. For this option to work linux users must set an environmental option.</p>
+<div class="sourceCode" id="cb13"><pre class="r"><span class="fu"><a href="https://rdrr.io/r/base/options.html">options</a></span>(<span class="kw">keyring_backend</span><span class="kw">=</span><span class="st">"file"</span>)</pre></div>
+<p>You will be asked to provide a password to encrypt the keyring with. Upon the start of each session you will be asked to provide this password, unlocking all <code>ecmwfr</code> credentials for this session. Should you ever forget the password just delete the file at: <code>~/.config/r-keyring/ecmwfr.keyring</code> and re-enter all your credentials.</p>
+</div>
 <div id="citation" class="section level2">
 <h2 class="hasAnchor">
 <a href="#citation" class="anchor"></a>Citation</h2>
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 2e0c09a..d836067 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -6,5 +6,5 @@ articles:
   advanced_vignette: advanced_vignette.html
   cds_vignette: cds_vignette.html
   webapi_vignette: webapi_vignette.html
-last_built: 2020-07-13T17:50Z
+last_built: 2020-07-13T17:55Z