Download the PHP package linkorb/vault without Composer
On this page you can find all versions of the php package linkorb/vault. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download linkorb/vault
More information about linkorb/vault
Files in linkorb/vault
Package vault
Short Description Vault: Store confidential data in version control
License MIT
Homepage http://www.github.com/linkorb/vault
Informations about the package vault
Vault
Securely store confidential information (passwords, ssl certificates, keys) in version control
Installing Vault
Vault is a tiny CLI application that you can add to your projects by adding the following line to your composer.json
:
"require": {
"linkorb/vault": "~1.0"
}
Run composer update
to install the new project dependency
Using Vault
Vault works with 2 directories:
- The
vault
directory (defaultvault/
): this directory stores the confidential information in encrypted form - The
secure
directory (defaultsecure/
): this directory contains your confidential files in unencrypted form, so that your application can use it. This directory will not be committed to version control, and should be added to your.gitignore
file.
To start, create both directories, and put a confidential file in your secure/
directory.
Type the following command, to encrypt all files in your secure/
directory, and store then in the vault/
directory:
vendor/bin/vault encrypt
Vault will ask for a password that will be used for encryption.
You can now check which files are stored in the vault using:
vendor/bin/vault ls
To echo the contents of a single file from vault, run:
vendor/bin/vault cat test.txt
Add your secure/
directory to .gitignore
, and commit the files in the vault/
directory.
To use the files on another computer, use git pull
to get the new files in the vault/
directory, and run the following command to decrypt them into the new local secure/
directory:
vendor/bin/vault decrypt
Vault will ask for a password again, and extract the files one by one into the secure/
directory, so they can be used.
If you make any changes to files in the secure/
directory, make sure to run vault encrypt
again to update the contents in vault/
so they can be sent to your version control system.
TODO:
- [ ] Make
vault/
andsecure/
directories configurable through aVaultfile
- [ ] Allow configurations of used encryption methods
- [ ] Add a
diff
command, to check changes between vault and secure directories
License
MIT. Please refer to the license file for details.
Brought to you by the LinkORB Engineering team
Check out our other projects at linkorb.com/engineering.
Btw, we're hiring!