summaryrefslogtreecommitdiff
path: root/src/docs/home.dox
blob: 3cde64877b23cc836027e288e10ea8bc4930f68f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/*! @page home Database Home Directory

WiredTiger file naming is based on the \c home argument specified to the
::wiredtiger_open function and the \c WIREDTIGER_HOME environment
variable, determined by the following steps:

-# If a \c home argument is specified to the ::wiredtiger_open function,
its value is used as the database directory.
-# If the \c WIREDTIGER_HOME environment variable is not set, the database
directory is the process' current working directory.  No current working
directory path is maintained by the WiredTiger software and changing the
working directory after opening the WiredTiger database may cause failure.
-# If the process is running with special privileges, the ::wiredtiger_open
function must be configured with the \c use_environment_priv flag.  The
\c use_environment_priv flag is intended for applications that have or
acquire special privileges and wish to use an environment-specified home
directory: if such an application does not configure the ::wiredtiger_open
function with the \c use_environment_priv flag, setting an environment
value will cause the open to fail.  On ISO/IEC 9945-1:1990 (POSIX.1)
systems, "special privileges" is defined as a real user ID not equal to the
effective user ID, or the real group ID not equal to the effective group
ID.
-# Otherwise, the value of the \c WIREDTIGER_HOME environment variable is
used as the database directory.

Finally, consider security when configuring WiredTiger to use the
\c WIREDTIGER_HOME environment variable, especially in applications which
run with permissions other than the user's.  Such applications are
potentially vulnerable to allowing users access to databases they could not
otherwise access.
*/