Skip to content

Commit 1f61222

Browse files
committed
Clarify that Darwin and BSD are supported w/ mlock
Word smith a tad.
1 parent d0ace6f commit 1f61222

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

website/source/docs/config/index.html.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,17 @@ sending a SIGHUP to the server process. These are denoted below.
6969
lease duration for tokens and secrets. This is a string value using a suffix,
7070
e.g. "720h". Default value is 30 days.
7171

72-
In production, you should only consider setting the `disable_mlock` option
73-
on Linux systems that only use encrypted swap or do not use swap at all.
74-
Vault does not currently support memory locking on Mac OS X and Windows
75-
and so the feature is automatically disabled on those platforms. To give
76-
the Vault executable access to the `mlock` syscall on Linux systems:
72+
In production it is a risk to run Vault on systems where `mlock` is
73+
unavailable or the setting has been disabled via the `disable_mlock`.
74+
Disabling `mlock` is not recommended unless the systems running Vault only
75+
use encrypted swap or do not use swap at all. Vault only supports memory
76+
locking on UNIX-like systems (Linux, FreeBSD, Darwin, etc). Non-UNIX like
77+
systems (e.g. Windows, NaCL, Android) lack the primitives to keep a process's
78+
entire memory address space from spilling disk and is therefore automatically
79+
disabled on unsupported platforms.
80+
81+
On Linux, to give the Vault executable the ability to use the `mlock` syscall
82+
without running the process as root, run:
7783

7884
```shell
7985
sudo setcap cap_ipc_lock=+ep $(readlink -f $(which vault))

0 commit comments

Comments
 (0)