keyring docs

bluegreen-labs · Jul 13, 2020 · d722435 · d722435
1 parent ba7a696
commit d722435
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git 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
diff --git 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