L<groupsecret> is a program that makes it easy for groups to share a secret between themselves
without exposing the secret to anyone else. It could be used, for example, by a team to share an
-L<ansible-vault(1)> password; see L</ansible-vault> for more about this particular use case.
+L<ansible-vault(1)> password.
The goal of this program is to be easy to use and have few dependencies (or only have dependencies
users are likely to already have installed).
-L<groupsecret> works by encrypting a secret with a symmetric cipher protected by a secure random
+groupsecret works by encrypting a secret with a symmetric cipher protected by a secure random
passphrase which is itself encrypted by one or more SSH2 RSA public keys. Only those who have access
to one of the corresponding private keys are able to decrypt the passphrase and access the secret.
Specify a path to a keyfile which stores a secret and keys.
-Defaults to the value of the environment variable C<GROUPSECRET_KEYFILE> or F<groupsecret.yml>.
+Defaults to the value of the environment variable L</GROUPSECRET_KEYFILE> or F<groupsecret.yml>.
Alias: C<-f>
Specify a path to a PEM private key. This is used by some commands to decrypt the passphrase that
protects the secret and is ignored by commands that don't need it.
-Defaults to the value of the environment variable L</GROUPSECRET_PRIVATE_KEY>. If that is unset, it
-defaults to F<~/.ssh/id_rsa>.
+Defaults to the value of the environment variable L</GROUPSECRET_PRIVATE_KEY> or F<~/.ssh/id_rsa>.
Alias: C<-k>
for in the filesystem; see L</GROUPSECRET_PATH>.
If the C<--update> option is used and a key with the same fingerprint is added, the new key will
-replaced the existing key. The default behavior is to skip existing keys.
+replace the existing key. The default behavior is to skip existing keys.
If the keyfile is storing a secret, the passphrase protecting the secret will need to be decrypted
so that access to the secret can be shared with the new key(s).
=head1 INSTALL
-There are several ways to install groupsecret to your system. First, make sure you first have the
+There are a few ways to install groupsecret to your system. First, make sure you first have the
L</REQUIREMENTS> installed.
=head2 Using cpanm
to install the F<groupsecret> executable to a system directory, like F</usr/local/bin/groupsecret>
(depending on your perl).
-=head2 Downloading just the executable
-
-You may also choose to download F<groupsecret> as a single executable, like this:
-
- curl -OL https://raw.githubusercontent.com/chazmcgarvey/groupsecret/solo/groupsecret
- chmod +x groupsecret
-
-This executable is fat-packed and includes all the non-core Perl module dependencies built-in.
-
=head2 For developers
If you're a developer and want to hack on the source, clone the repository and pull the
Defaults to C<.:keys:$HOME/.ssh>.
-=head1 EXAMPLES
-
-=head2 ansible-vault
-
-TODO
-
=cut
use warnings FATAL => 'all';