2015-04-10 04:49:52 +00:00
|
|
|
---
|
2017-03-06 21:10:09 +00:00
|
|
|
layout: "docs"
|
2017-03-08 22:33:58 +00:00
|
|
|
page_title: "Install Vault"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
sidebar_title: "Installing Vault"
|
2017-03-08 22:33:58 +00:00
|
|
|
sidebar_current: "docs-install-install"
|
2015-04-10 04:49:52 +00:00
|
|
|
description: |-
|
2017-03-08 22:33:58 +00:00
|
|
|
Installing Vault is simple. You can download a precompiled binary or compile
|
|
|
|
from source. This page details both methods.
|
2015-04-10 04:49:52 +00:00
|
|
|
---
|
|
|
|
|
2017-03-08 22:33:58 +00:00
|
|
|
# Install Vault
|
2015-04-10 04:49:52 +00:00
|
|
|
|
2017-03-08 22:33:58 +00:00
|
|
|
Installing Vault is simple. There are two approaches to installing Vault:
|
2015-04-10 04:49:52 +00:00
|
|
|
|
2017-03-08 22:33:58 +00:00
|
|
|
1. Using a [precompiled binary](#precompiled-binaries)
|
|
|
|
|
|
|
|
1. Installing [from source](#compiling-from-source)
|
|
|
|
|
|
|
|
Downloading a precompiled binary is easiest, and we provide downloads over TLS
|
|
|
|
along with SHA256 sums to verify the binary. We also distribute a PGP signature
|
|
|
|
with the SHA256 sums that can be verified.
|
|
|
|
|
|
|
|
## Precompiled Binaries
|
|
|
|
|
|
|
|
To install the precompiled binary, [download](/downloads.html) the appropriate
|
|
|
|
package for your system. Vault is currently packaged as a zip file. We do not
|
|
|
|
have any near term plans to provide system packages.
|
|
|
|
|
|
|
|
Once the zip is downloaded, unzip it into any directory. The `vault` binary
|
|
|
|
inside is all that is necessary to run Vault (or `vault.exe` for Windows). Any
|
|
|
|
additional files, if any, aren't required to run Vault.
|
|
|
|
|
|
|
|
Copy the binary to anywhere on your system. If you intend to access it from the
|
|
|
|
command-line, make sure to place it somewhere on your `PATH`.
|
|
|
|
|
|
|
|
## Compiling from Source
|
|
|
|
|
|
|
|
To compile from source, you will need [Go](https://golang.org) installed and
|
|
|
|
configured properly (including a `GOPATH` environment variable set), as well
|
|
|
|
as a copy of [`git`](https://www.git-scm.com/) in your `PATH`.
|
|
|
|
|
|
|
|
1. Clone the Vault repository from GitHub into your `GOPATH`:
|
|
|
|
|
|
|
|
```shell
|
2018-03-08 16:02:04 +00:00
|
|
|
$ mkdir -p $GOPATH/src/github.com/hashicorp && cd $_
|
2017-03-08 22:33:58 +00:00
|
|
|
$ git clone https://github.com/hashicorp/vault.git
|
|
|
|
$ cd vault
|
|
|
|
```
|
|
|
|
|
|
|
|
1. Bootstrap the project. This will download and compile libraries and tools
|
|
|
|
needed to compile Vault:
|
|
|
|
|
|
|
|
```shell
|
|
|
|
$ make bootstrap
|
|
|
|
```
|
|
|
|
|
|
|
|
1. Build Vault for your current system and put the
|
|
|
|
binary in `./bin/` (relative to the git checkout). The `make dev` target is
|
|
|
|
just a shortcut that builds `vault` for only your local build environment (no
|
|
|
|
cross-compiled targets).
|
|
|
|
|
|
|
|
```shell
|
|
|
|
$ make dev
|
|
|
|
```
|
|
|
|
|
|
|
|
## Verifying the Installation
|
|
|
|
|
2017-10-27 14:44:56 +00:00
|
|
|
To verify Vault is properly installed, run `vault -h` on your system. You should
|
2017-03-08 22:33:58 +00:00
|
|
|
see help output. If you are executing it from the command line, make sure it is
|
|
|
|
on your PATH or you may get an error about Vault not being found.
|
|
|
|
|
|
|
|
```shell
|
2017-10-27 14:44:56 +00:00
|
|
|
$ vault -h
|
2017-03-08 22:33:58 +00:00
|
|
|
```
|