| 1 |
.\" Hey, EMACS: -*- nroff -*- |
| 2 |
.\" (C) Copyright 2014 XOR Data Exchange, Inc. |
| 3 |
.\" |
| 4 |
.\" First parameter, NAME, should be all caps |
| 5 |
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
| 6 |
.\" other parameters are allowed: see man(7), man(1) |
| 7 |
.TH CRYPT-XORDATAEXCHANGE 1 "September 2015" |
| 8 |
.\" Please adjust this date whenever revising the manpage. |
| 9 |
.\" |
| 10 |
.\" Some roff macros, for reference: |
| 11 |
.\" .nh disable hyphenation |
| 12 |
.\" .hy enable hyphenation |
| 13 |
.\" .ad l left justify |
| 14 |
.\" .ad b justify to both left and right margins |
| 15 |
.\" .nf disable filling |
| 16 |
.\" .fi enable filling |
| 17 |
.\" .br insert line break |
| 18 |
.\" .sp <n> insert n+1 empty lines |
| 19 |
.\" for manpage-specific macros, see man(7) |
| 20 |
.SH NAME |
| 21 |
crypt-xordataexchange \- Store and retrieve encrypted configuration parameters from etcd or Consul |
| 22 |
|
| 23 |
.SH SYNOPSIS |
| 24 |
.B crypt-xordataexchange |
| 25 |
.RI "get [" arg "...] " key |
| 26 |
.br |
| 27 |
.B crypt-xordataexchange |
| 28 |
.RI "list [" arg "...] " key |
| 29 |
.br |
| 30 |
.B crypt-xordataexchange |
| 31 |
.RI "set [" arg "...] " key " " file |
| 32 |
|
| 33 |
.SH DESCRIPTION |
| 34 |
.B Fess up. |
| 35 |
You have passwords and usernames hard coded in your apps. |
| 36 |
You have IP addresses checked in to your source code repository. |
| 37 |
You have entire configuration files that were created by the developer |
| 38 |
who wrote the app and haven't been changed since she typed "git init". |
| 39 |
.PP |
| 40 |
.BR "crypt " ( crypt-xordataexchange ) |
| 41 |
is here to lead you back to the Path of Enlightened Configuration. |
| 42 |
Store encrypted configuration values in etcd or Consul using a command-line |
| 43 |
application. |
| 44 |
|
| 45 |
.SH COMMANDS |
| 46 |
.TP |
| 47 |
.B get |
| 48 |
retrieve the value of a key |
| 49 |
.TP |
| 50 |
.B list |
| 51 |
retrieve all values under a key |
| 52 |
.TP |
| 53 |
.B set |
| 54 |
set the value of a key |
| 55 |
|
| 56 |
.SH OPTIONS |
| 57 |
.TP |
| 58 |
.B \-backend\fP="etcd" |
| 59 |
backend provider |
| 60 |
.TP |
| 61 |
.B \-endpoint\fP="" |
| 62 |
backend URL |
| 63 |
.TP |
| 64 |
.B \-keyring\fP=".pubring.gpg" |
| 65 |
path to armored public keyring (for \fBset\fP only) |
| 66 |
.TP |
| 67 |
.B \-secret-keyring\fP=".secring.gpg" |
| 68 |
path to armored secret keyring (for \fBget\fP and \fBlist\fP only) |
| 69 |
.TP |
| 70 |
.B \-plaintext\fP=false |
| 71 |
don't encrypt or decrypt the values before storage or retrieval |
| 72 |
|
| 73 |
.SH COPYRIGHT |
| 74 |
Copyright \(co 2014 XOR Data Exchange, Inc. |
| 75 |
.br |
| 76 |
Distributed under the MIT License. |
| 77 |
|
| 78 |
.SH SEE ALSO |
| 79 |
Full documentation at: <http://xordataexchange.github.io/crypt/> |
| 80 |
.br |
| 81 |
GitHub: <https://github.com/xordataexchange/crypt> |