github.com/StackExchange/blackbox/v2@v2.0.1-0.20220331193400-d84e904973ab/README-v2.md (about)

     1  BlackBox v2
     2  ===========
     3  
     4  WARNING: v2 is still experimental.  It is in the same git repo as v1
     5  because the filenames do not overlap.  Please do not mix the two.  v1
     6  is in `bin`.  v2 is in `cmd/blackbox` and `binv2`.
     7  
     8  Blackbox is an open source tool that enables you to safe store sensitive information in
     9  Git (or other) repos by encrypting them with GPG.  Only the encrypted
    10  version of the file is available.  You can be free to provide access
    11  to the repo, as but only people with the right GPG keys can access the
    12  encrypted data.
    13  
    14  Things you should **never** store in a repo without encryption:
    15  
    16  * TLS (SSL) certificates
    17  * Passwords
    18  * API keys
    19  * And more!
    20  
    21  Project Info:
    22  
    23  * [Overview](user-overview.md)
    24  * [Why is this important?](why-is-this-important.md)
    25  * [Support/Community](support.md)
    26  * [How BB encrypts](encryption.md)
    27  * [OS Compatibility](compatibility.md)
    28  * [Installation Instructions](installation.md)
    29  * [Alternatives](alternatives.md)
    30  
    31  User Info:
    32  
    33  * [Enabling Blackbox on a Repo](enable-repo.md)
    34  * [Enroll a file](enable-repo.md)
    35  * [Full Command List](full-command-list.md)
    36  * [Add/Remove users](admin-ops.md)
    37  * [Add/Remove files](file-ops.md)
    38  * [Advanced techiques](advanced.md)
    39  * [Use with Role Accounts](role-accounts.md)
    40  * [Backwards Compatibility](backwards-compatibility.md)
    41  * [Replacing expired keys](expired-keys.md)
    42  * [Git Tips](git-tips.md)
    43  * [SubVersion Tips](subversion-tips.md)
    44  * [GnuPG tips](gnupg-tips.md)
    45  * [Use with Ansible](with-ansible.md)
    46  * [Use with Puppet](with-puppet.md)
    47  
    48  For contributors:
    49  
    50  * [Developer Info](dev.md)
    51  * [Code overview](dev-code-overview.md)
    52  * [HOWTO: Add new OS support](dev-add-os-support.md)
    53  * [HOWTO: Add new VCS support](dev-add-vcs-support.md)
    54  
    55  
    56  A slide presentation about an older release [is on SlideShare](http://www.slideshare.net/TomLimoncelli/the-blackbox-project-sfae).
    57  
    58  Join our mailing list: [https://groups.google.com/d/forum/blackbox-project](https://groups.google.com/d/forum/blackbox-project)
    59  
    60  
    61  License
    62  =======
    63  
    64  This content is released under the MIT License.
    65  See the [LICENSE.txt](LICENSE.txt) file.