Skip to content
Snippets Groups Projects
Commit 37159cec authored by Conrad Lara's avatar Conrad Lara
Browse files

Populate README with basic instructions.

parent 2c7ce614
No related branches found
Tags 7.x-1.0-rc3
No related merge requests found
# vault
CONTENTS OF THIS FILE
---------------------
| Branch | Build Status |
| ------ | ------------ |
| [8.x-1.x](https://www.drupal.org/project/vault/releases/8.x-1.x-dev) | [![CircleCI](https://img.shields.io/circleci/project/github/nicksantamaria/drupal-vault/8.x-1.x.svg?style=for-the-badge)](https://circleci.com/gh/nicksantamaria/drupal-vault/tree/8.x-1.x) |
* Introduction
* Requirements
* Optional Requirements
* Installation
* Configuration
* Maintainers
* Previous Maintainers
>Initial description.
INTRODUCTION
------------
## Get Started
What is HashiCorp Vault?
> Background knowledge required
Vault is a tool for securely accessing secrets. A secret is anything that
you want to tightly control access to, such as API keys, passwords, or
certificates.
The Vault module provides a client for connecting to HashiCorp Vault server.
> External dependencies
* For the full description of the module visit:
https://www.drupal.org/project/vault
> Internal dependencies
* To submit bug reports and feature suggestions, or to track changes visit:
https://www.drupal.org/project/issues/vault
> Steps to set up.
REQUIREMENTS
------------
## Contribute
- An accessible Vault Server.
- csharpru/vault-php (installed by composer)
- A Vault Authentication Strategy plugin.
- [Token Authentication](https://www.drupal.org/project/vault_auth_token)
- [AppRole Authentication](https://www.drupal.org/project/vault_auth_approle)
Development of this module takes place on [GitHub](https://github.com/nicksantamaria/drupal-vault).
OPTIONAL REQUIREMENTS
---------------------
* If you encounter issues, please [search the backlog](https://github.com/nicksantamaria/drupal-vault/issues).
* Please [create issues](https://github.com/nicksantamaria/drupal-vault/issues/new?labels=bug) and [feature requests](https://github.com/nicksantamaria/drupal-vault/issues/new?labels=enhancement) in GitHub.
* Even better, feel free to fork this repo and [make pull requests](https://github.com/nicksantamaria/drupal-vault/compare).
- [Encrypt](https://www.drupal.org/project/encrypt)
INSTALLATION
------------
Install the Vault module as you would normally install a contributed
Drupal module. Visit https://www.drupal.org/node/1897420 for further
information.
Install an Authentication Strategy and configure as documented by the strategy.
CONFIGURATION
-------------
1. Verify you have an Authentication Strategy installed.
2. Navigate to admin/config/system/vault.
3. Provide the URL for accessing your Vault server on the settings form or in
your settings.php file.
4. Configure the Authentication Strategy.
5. Optionally: Configure an alternative Lease Storage plugin. The default module
'Drupal State' stores leases in the Drupal State. If you have the optional
Encrypt module you may use the "Encrypted State" plugin to avoid plain-text
credentials stored in the database. Encrypted State paired with the
vault_transit_encrypt encryption provider allows for the burden of
cryptographic key management to be centralized in Vault.
6. Save the configuration.
7. Validate no errors are displayed when viewing admin/reports/status.
MAINTAINERS
-----------
* Conrad Lara - https://www.drupal.org/u/cmlara
PREVIOUS MAINTAINERS
--------------------
Nick Santamaria - https://www.drupal.org/u/nicksanta
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment