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

Adding Perforce to README

Browse Source
This commit is contained in:
Stas Alekseev
2015-03-24 10:39:36 -04:00
parent caf7402a03
commit 6185f50942
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,7 +1,7 @@
BlackBox BlackBox
======== ========
Safely store secrets in a VCS repo (i.e. Git, Mercurial, or Subversion). These Safely store secrets in a VCS repo (i.e. Git, Mercurial, Subversion or Perforce). 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
@@ -42,16 +42,16 @@ files. Simply set up a GPG key for the Puppet master (or the role
account that pushes new files to the Puppet master) and have that account that pushes new files to the Puppet master) and have that
user run `blackbox_postdeploy` after any files are updated. user run `blackbox_postdeploy` after any files are updated.
Getting started is easy. Just `cd` into a Git, Mercurial or Subversion Getting started is easy. Just `cd` into a Git, Mercurial, Subversion or
repository and run `blackbox_initialize`. After that, if a file is to Perforce repository and run `blackbox_initialize`. After that, if a file is to
be encrypted, run `blackbox_register_new_file` and you are done. Add be 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`; this will decrypt the To view and/or edit a file, run `blackbox_edit`; this will decrypt the
file and open with whatever is specified by your $EDITOR environment file and open with whatever is specified by your $EDITOR environment
variable. When you close the editor the file will automatically be variable. When you close the editor the file will automatically be
encrypted again and the temporary plaintext file will be shredded. If 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 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 `blackbox_edit_start` to decrypt the file and `blackbox_edit_end` when
you want to "put it back in the box." you want to "put it back in the box."
@@ -116,6 +116,7 @@ It has been tested to work with many operating systems.
* `git` -- The Git * `git` -- The Git
* `hg` -- Mercurial * `hg` -- Mercurial
* `svn` -- SubVersion (Thanks, Ben Drasin!) * `svn` -- SubVersion (Thanks, Ben Drasin!)
* `p4` -- Perforce
* Operating system * Operating system
* CentOS / RedHat * CentOS / RedHat
* MacOS X * MacOS X
@@ -132,7 +133,7 @@ Note: Cywin support requires the following packages:
* Normal operation: * Normal operation:
* gnupg * gnupg
* git or mercurial or subversion (as appropriate) * git or mercurial or subversion or perforce (as appropriate)
* Development (if you will be adding code and want to run the confidence test) * Development (if you will be adding code and want to run the confidence test)
* procps * procps
* make * make