From 7287db47e5e18a94d99391117cbcdc1a77fcce36 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Wed, 12 Aug 2015 16:54:35 +0200 Subject: [PATCH] Added documentation --- LICENSE | 13 +++++++++++++ README.md | 21 +++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4fde5d2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2015 Knut Ahlers + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f36a4a --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Jimdo / vault-unseal + +[![License: Apache v2.0](https://badge.luzifer.io/v1/badge?color=5d79b5&title=license&text=Apache+v2.0)](http://www.apache.org/licenses/LICENSE-2.0) + +This small utility is a helper to automatically unlock a [Vault](https://www.vaultproject.io/) instance by having an amount of servers having access to one or multiple tokens. + +## Features + +- Provide one or multiple tokens for the unseal command +- `vault-unseal` does check whether the vault instance is locked and tries to unlock if it is locked + +## Usage + +```bash +# ./vault-unseal --help +Usage of ./vault-unseal: + --instance="http://127.0.0.1:8200": Vault instance to unlock + -1, --oneshot[=true]: Only try once and exit after + --sleep=30: How long to wait between sealed-state checks + --tokens="": Tokens to try for unsealing the vault instance +```