diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..e38a66851 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,68 @@ +# SOPS: Secrets OPerationS + +`sops` is a secrets management solution and editor of encrypted files that +supports a variety of file formats and encryption providers. + +Here is a quick demo of `sops` in action: + + + + +A more in-depth overview is available as part of Julien Vehent's Securing +DevOps Show & Tell: + + + +If you want to use SOPS as a Go library, take a look at the [decrypt +package](https://godoc.org/go.mozilla.org/sops/decrypt). + +**Questions?** Ping `ulfr` and `autrilla` in `#security` on +[`irc.mozilla.org`](https://wiki.mozilla.org/IRC) (you can use a web client +like [mibbit](https://chat.mibbit.com)). + +**What happened to Python SOPS?** We rewrote `sops` in Go to solve a number of +deployment issues, but the Python branch still exists under `python-sops`. We +will keep maintaining it for a while, and you can still `pip install sops`, but +we strongly recommend you use the Go version instead. + +Backward compatibility +---------------------- + +We strive to make as few backwards-incompatible changes as possible to the +`sops` command line tool. We follow [Semantic Versioning](https://semver.org/), +so in the rare occurence that we break compatibility on the CLI, you'll know. + +The file format will always be backwards compatible: this means that newer +versions of SOPS will be able to load files created with older versions of +SOPS. + +Security +-------- + +Please report security issues to jvehent at mozilla dot com, or by using one of +the contact method available on keybase: https://keybase.io/jvehent + +License +------- + +Mozilla Public License Version 2.0 + +Authors +------- + +The core team is composed of: + +* Adrian Utrilla [@autrilla](https://github.com/autrilla) +* Julien Vehent [@jvehent](https://github.com/jvehent) +* AJ Banhken [@ajvb](https://github.com/ajvb) + +And a whole bunch of [contributors](https://github.com/mozilla/sops/graphs/contributors). + +Credits +------- + +SOPS was inspired by [hiera-eyaml](https://github.com/TomPoulton/hiera-eyaml), +[credstash](https://github.com/LuminalOSS/credstash), +[sneaker](https://github.com/codahale/sneaker), [password +store](http://www.passwordstore.org/), and too many years managing PGP +encrypted files by hand. diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 000000000..b0647efa0 --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,36 @@ + + +* [SOPS](/) +* [Installation](installation.md) +* [Quick Start](quick_start.md) +* Usage + * [Encrypting files](usage/encrypting_files.md) + * [Decrypting files](usage/decrypting_files.md) + * [Editing files](usage/editing_files.md) + * [Git differ](usage/git_differ.md) + * [Key rotation](usage/key_rotation.md) + * [Key groups](usage/key_groups.md) + * [Publishing files](usage/publishing_files.md) + * [Key service](usage/key_service.md) + * [Auditing](usage/auditing.md) + * [Partial file encryption](usage/partial_file_encryption.md) +* [The `.sops.yaml` configuration file](sops_yaml_config_file.md) +* Encryption providers (master key types) + * [AWS KMS](encryption_providers/aws_kms.md) + * [GCP KMS](encryption_providers/gcp_kms.md) + * [Azure KeyVault](encryption_providers/azure_keyvault.md) + * [PGP](encryption_providers/pgp.md) +* Storage formats + * [YAML](storage_formats/yaml.md) + * [JSON](storage_formats/json.md) + * [.env](storage_formats/dotenv.md) + * [INI](storage_formats/ini.md) + * [Arbitrary (binary) files](storage_formats/binary.md) +* Publication targets + * [AWS S3](publication_targets/s3.md) + * [Google Cloud Storage](publication_targets/gcs.md) + * [Hashicorp Vault](publication_targets/vault.md) +* Internals + * [Encryption protocol](internals/encryption_protocol.md) +* [Comparison with other tools](comparison_with_other_tools.md) + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 000000000..0215c051e --- /dev/null +++ b/docs/index.html @@ -0,0 +1,24 @@ + + +
+ +