george/blackbox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
mention subversion support, mention blackbox_edit more prominently
This commit is contained in:
Benjamin Drasin
2014-10-20 10:37:34 -07:00
parent 2f9dd20544
commit 8d04df1faa
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -7,7 +7,7 @@ git/mercurial server unless you trust everyone with root access and access to yo
BlackBox BlackBox
======== ========
Safely store secrets in a VCS repo (i.e. Git or Mercurial). These Safely store secrets in a VCS repo (i.e. Git, Mercurial, or Subversion). These
commands make it easy commands make it easy
for you to Gnu Privacy Guard (GPG) encrypt specific files in a repo so they are for you to Gnu Privacy Guard (GPG) encrypt specific files in a repo so they are
"encrypted at rest" in your repository. However, the scripts "encrypted at rest" in your repository. However, the scripts
@@ -52,8 +52,13 @@ Getting started is easy. Just `cd` into a Git or Mercurial repository
and run `blackbox_initialize`. After that, if a file is to be and run `blackbox_initialize`. After that, if a file is to be
encrypted, run `blackbox_register_new_file` and you are done. Add encrypted, run `blackbox_register_new_file` and you are done. Add
and remove keys with `blackbox_addadmin` and `blackbox_removeadmin`. and remove keys with `blackbox_addadmin` and `blackbox_removeadmin`.
To view and/or edit a file, run `blackbox_edit_start`. Run To view and/or edit a file, run `blackbox_edit`; this will decrypt the
`blackbox_edit_end` when you want to "put it back in the box." file and open with whatever is specified by your $EDITOR environment
variable. When you close the editor the file will automatically be
encrypted again and the temporary plaintext file will be shredded. If
you need to leave the file decrypted while you update you can use the
`blackbox_edit_start` to decrypt the file and `blackbox_edit_end` when
you want to "put it back in the box."
Why is this important? Why is this important?