2015-04-07 02:01:15 +00:00
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
layout: intro
|
|
|
|
page_title: Starting the Server - Getting Started
|
|
|
|
sidebar_title: Starting the Server
|
|
|
|
description: 'After installing Vault, the next step is to start the server.'
|
2015-04-07 02:01:15 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Starting the Vault Server
|
|
|
|
|
|
|
|
With Vault installed, the next step is to start a Vault server.
|
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
Vault operates as a client/server application. The Vault server is the only
|
|
|
|
piece of the Vault architecture that interacts with the data storage and
|
|
|
|
backends. All operations done via the Vault CLI interact with the server over a
|
|
|
|
TLS connection.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
In this page, we'll start and interact with the Vault server to understand how
|
|
|
|
the server is started.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
## Starting the Dev Server
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
First, we're going to start a Vault _dev server_. The dev server is a built-in,
|
|
|
|
pre-configured server that is not very secure but useful for playing with Vault
|
|
|
|
locally. Later in this guide we'll configure and start a real server.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
To start the Vault dev server, run:
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
```shell-session
|
2018-08-23 23:34:50 +00:00
|
|
|
$ vault server -dev
|
|
|
|
==> Vault server configuration:
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
Cgo: disabled
|
|
|
|
Cluster Address: https://127.0.0.1:8201
|
|
|
|
Listener 1: tcp (addr: "127.0.0.1:8200", cluster address: "127.0.0.1:8201", tls: "disabled")
|
|
|
|
Log Level: info
|
|
|
|
Mlock: supported: false, enabled: false
|
|
|
|
Redirect Address: http://127.0.0.1:8200
|
|
|
|
Storage: inmem
|
|
|
|
Version: Vault v1.2.3
|
|
|
|
Version Sha: ...
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
WARNING! dev mode is enabled! In this mode, Vault runs entirely in-memory
|
|
|
|
and starts unsealed with a single unseal key. The root token is already
|
|
|
|
authenticated to the CLI, so you can immediately begin using Vault.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
You may need to set the following environment variable:
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
$ export VAULT_ADDR='http://127.0.0.1:8200'
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
The unseal key and initial root token are displayed below in case you want to
|
|
|
|
seal/unseal the Vault or re-authenticate.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
Unseal Key: 1aKM7rNnyW+7Jx1XDAXFswgkRVe+78JB28k/bel90jY=
|
|
|
|
Root Token: root
|
2017-09-13 01:48:52 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
Development mode should NOT be used in production installations!
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
==> Vault server started! Log data will stream in below:
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
# ...
|
|
|
|
```
|
2018-08-02 02:01:53 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
You should see output similar to that above. Vault does not fork, so it will
|
|
|
|
continue to run in the foreground. Open another shell or terminal tab to run the
|
|
|
|
remaining commands.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
The dev server stores all its data in-memory (but still encrypted), listens on
|
|
|
|
`localhost` without TLS, and automatically unseals and shows you the unseal key
|
|
|
|
and root access key. **Do not run a dev server in production!**
|
2015-10-30 16:47:31 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
With the dev server running, do the following three things before anything else:
|
2015-04-07 02:01:15 +00:00
|
|
|
|
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
|
|
|
1. Launch a new terminal session.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
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
|
|
|
2. Copy and run the `export VAULT_ADDR ...` command from the terminal
|
|
|
|
output. This will configure the Vault client to talk to our dev server.
|
2016-12-14 15:34:52 +00:00
|
|
|
|
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
|
|
|
3. Save the unseal key somewhere. Don't worry about _how_ to save this
|
|
|
|
securely. For now, just save it anywhere.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
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
|
|
|
4. Do the same as step 3, but with the root token. We'll use this later.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
## Verify the Server is Running
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
As instructed, copy and execute `export VAULT_ADDR='http://127.0.0.1:8200'`.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
Verify the server is running by running the `vault status` command. This should
|
|
|
|
succeed and exit with exit code 0.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
If it ran successfully, the output should look like the below:
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
```shell-session
|
2018-08-23 23:34:50 +00:00
|
|
|
$ vault status
|
|
|
|
Key Value
|
|
|
|
--- -----
|
|
|
|
Sealed false
|
|
|
|
Total Shares 1
|
|
|
|
Version (version unknown)
|
|
|
|
Cluster Name vault-cluster-81109a1a
|
|
|
|
Cluster ID f6e0aa8a-700e-38b8-5dc5-4265c880b2a1
|
|
|
|
HA Enabled false
|
|
|
|
```
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
If the output looks different, especially if the numbers are different or the
|
|
|
|
Vault is sealed, then restart the dev server and try again. The only reason
|
|
|
|
these would ever be different is if you're running a dev server from going
|
|
|
|
through this guide previously.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
We'll cover what this output means later in the guide.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
## Next
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
Congratulations! You've started your first Vault server. We haven't stored
|
|
|
|
any secrets yet, but we'll do that in the next section.
|
2015-04-07 02:01:15 +00:00
|
|
|
|
2018-08-23 23:34:50 +00:00
|
|
|
Next, we're going to
|
2020-01-22 20:05:41 +00:00
|
|
|
[read and write our first secrets](/intro/getting-started/first-secret).
|