Skip to content

Commit

Permalink
docs: Add correct method for mlock on systemd (#3704)
Browse files Browse the repository at this point in the history
Although the previously described method of running setcap works if
setcap is available, the built-in LimitMEMLOCK directive is better.
  • Loading branch information
jen20 authored and jefferai committed Dec 18, 2017
1 parent bb667bf commit eb0cd8c
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions website/source/docs/configuration/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,12 @@ to specify where the configuration is.
sudo setcap cap_ipc_lock=+ep $(readlink -f $(which vault))
```

If you use a Linux distribution with systemd, you can also add the above `setcap` command as an [ExecStartPre](https://www.freedesktop.org/software/systemd/man/systemd.service.html#ExecStartPre=) additional command in your Vault unit file to ensure that `mlock()` capability is added to the `vault` binary before executing.
If you use a Linux distribution with a modern version of systemd, you can add
the following directive to the "[Service]" configuration section:

```ini
LimitMEMLOCK=infinity
```

- `plugin_directory` `(string: "")` – A directory from which plugins are
allowed to be loaded. Vault must have permission to read files in this
Expand All @@ -105,9 +110,9 @@ to specify where the configuration is.
duration for tokens and secrets. This is specified using a label
suffix like `"30s"` or `"1h"`.

- `raw_storage_endpoint` `(bool: false)` – Enables the `sys/raw` endpoint which
allows the decryption/encryption of raw data into and out of the security
barrier. This is a highly privileged endpoint.
- `raw_storage_endpoint` `(bool: false)` – Enables the `sys/raw` endpoint which
allows the decryption/encryption of raw data into and out of the security
barrier. This is a highly privileged endpoint.

- `ui` `(bool: false, Enterprise-only)` – Enables the built-in web UI, which is
available on all listeners (address + port) at the `/ui` path. Browsers accessing
Expand Down

0 comments on commit eb0cd8c

Please sign in to comment.