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

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