# @atomist/automation-client-ext-vault

> Extension for resolving placeholders and secrets in client configuration from vault

Latest version **1.0.1** (published 2019-07-10) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @atomist/automation-client-ext-vault
pnpm add @atomist/automation-client-ext-vault
yarn add @atomist/automation-client-ext-vault
bun add @atomist/automation-client-ext-vault
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-07-10 |
| First published | 2018-11-15 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 8.x.x |
| Dependencies | 2 |
| Unpacked size | 144.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Atomist |
| Maintainers | atomist |
| Keywords | atomist, automation, vault |

## Links

- npm: https://www.npmjs.com/package/@atomist/automation-client-ext-vault
- Repository: https://github.com/atomist/automation-client-ext-vault
- Homepage: https://github.com/atomist/automation-client-ext-vault#readme
- Issues: https://github.com/atomist/automation-client-ext-vault/issues
- npm.io page: https://npm.io/package/@atomist/automation-client-ext-vault

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^4.17.13
- [node-vault](https://npm.io/package/node-vault.md) ^0.9.10

## Recent versions

- 1.0.1 (latest) — 2019-07-10
- 1.0.1-master.20190710110741 (branch-master) — 2019-07-10
- 1.0.1-atomist-update-20190710105916.20190710110100 — 2019-07-10
- 1.0.1-master.20190709162959 — 2019-07-09
- 1.0.1-atomist-update-1.6.1-20190709162144.20190709162306 — 2019-07-09
- 1.0.1-master.20190709150705 — 2019-07-09
- 1.0.1-atomist-update-latest-20190709145635.20190709145802 — 2019-07-09
- 1.0.1-master.20190709145130 — 2019-07-09
- 1.0.1-atomist-update-branch-master-20190709143800.20190709143929 — 2019-07-09
- 1.0.1-master.20190709140310 — 2019-07-09
- 1.0.1-atomist-update-latest-20190709134925.20190709135148 — 2019-07-09
- 1.0.1-master.20190709134433 — 2019-07-09
- 1.0.1-atomist-update-branch-master-20190709132833.20190709133428 — 2019-07-09
- 1.0.1-master.20190709100839 — 2019-07-09
- 1.0.1-atomist-update-latest-20190709094647.20190709095032 — 2019-07-09
- … 31 more at https://npm.io/package/@atomist/automation-client-ext-vault/versions

## README

# @atomist/automation-client-ext-vault

An extension to an Atomist automation-client to resolve secret and configuration values in 
client configuration from Hashicorp Vault.

## Usage

1. First install the dependency in your automation-client project

```
$ npm install @atomist/automation-client-ext-vault
```

2. Install the support in your `atomist.config.ts`

```
import { configureVaultLookup } from "@atomist/automation-client-ext-vault";

export const configuration: Configuration = {
    postProcessors: [
        configureVaultLookup({ token: "<your vault token>", endpoint: "<vault endpoint url>" }),
    ],
}
```

If the `token` and `endpoint` options aren't provided, this falls back to lookup from 
environment variables `VAULT_TOKEN` and `VAULT_ADDR`.

## Support

General support questions should be discussed in the `#support`
channel on our community Slack team
at [atomist-community.slack.com][slack].

If you find a problem, please create an [issue][].

[issue]: https://github.com/atomist/automation-client-ext-dashboard/issues

## Development

You will need to install [node][] to build and test this project.

### Build and Test

Command | Reason
------- | ------
`npm install` | install all the required packages
`npm run build` | lint, compile, and test
`npm run lint` | run tslint against the TypeScript
`npm run compile` | compile all TypeScript into JavaScript
`npm test` | run tests and ensure everything is working
`npm run clean` | remove stray compiled JavaScript files and build directory

---

Created by [Atomist][atomist].
Need Help?  [Join our Slack team][slack].

[atomist]: https://atomist.com/ (Atomist - Development Automation)
[slack]: https://join.atomist.com/ (Atomist Community Slack)

---
_Source: https://npm.io/package/@atomist/automation-client-ext-vault · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
