76 lines
2.6 KiB
Plaintext
76 lines
2.6 KiB
Plaintext
|
Elements:
|
||
|
|
|
||
|
|
db_host
|
||
|
|
|
||
|
|
This is the ip address or host name of the database
|
||
|
|
server the application will attempt to connect to. This
|
||
|
|
is ignored if using sqlite as the database driver or
|
||
|
|
any driver that use local file storage.
|
||
|
|
|
||
|
|
db_name
|
||
|
|
|
||
|
|
This is the name of the database the file system will
|
||
|
|
attempt to use after connecting to the host. This can be
|
||
|
|
used to specify the target storage path if using a
|
||
|
|
driver that uses local file storage.
|
||
|
|
|
||
|
|
db_pw
|
||
|
|
|
||
|
|
This is the password used to authenticate with the
|
||
|
|
database if a password is required. Start this value with
|
||
|
|
a ? if you want this application to obtain the password
|
||
|
|
from the output of an external command.
|
||
|
|
Example: ?decrypt_pw
|
||
|
|
|
||
|
|
db_uname
|
||
|
|
|
||
|
|
This is the authentication username that will be used if
|
||
|
|
such a thing is required by the database driver. Start
|
||
|
|
this value with a ? if you want this application to
|
||
|
|
obtain the username from the output of an external
|
||
|
|
command.
|
||
|
|
Example: ?whoami
|
||
|
|
|
||
|
|
db_drv
|
||
|
|
|
||
|
|
This is the QT based database driver that will be used
|
||
|
|
when attempting to create a database connection. There
|
||
|
|
are several database drivers available for QT such as
|
||
|
|
MySQL, Sqlite, PostgreSQL, and Microsoft ODBC. As of
|
||
|
|
today, this application only supports MySQL and Sqlite.
|
||
|
|
use: --list-db-drvs to determine what drivers are
|
||
|
|
available to use for this parameter.
|
||
|
|
|
||
|
|
db_max_bytes
|
||
|
|
|
||
|
|
This value is used to report back to the operating
|
||
|
|
system the maximum amount of bytes that can be stored in
|
||
|
|
the database. This limit is actively enforced by the file
|
||
|
|
system. It will honor engineering notation so the byte
|
||
|
|
size can be written as 5KB, 5MB, 5GB, etc...
|
||
|
|
|
||
|
|
mnt_pnt
|
||
|
|
|
||
|
|
This is the directory the application will use to mount
|
||
|
|
the database file system. This directory must already
|
||
|
|
exist and have at least read+execute permissions to this
|
||
|
|
directory to successfully mount the database.
|
||
|
|
|
||
|
|
mnt_dataset
|
||
|
|
|
||
|
|
Forks and snapshots are called datasets and all most
|
||
|
|
have a unique name for each of them. This parameter
|
||
|
|
tells the application which dataset to use when mounting
|
||
|
|
the file system. This application automatically creates
|
||
|
|
the origin dataset called "root" if it doesn't exists.
|
||
|
|
The root dataset is considered the main dataset and
|
||
|
|
cannot be deleted in the same way the forks and snapshots
|
||
|
|
can. Note: snapshots are read only so if you mount a
|
||
|
|
snapshot, the filesystem will operate in read only mode.
|
||
|
|
|
||
|
|
read_only
|
||
|
|
|
||
|
|
This parameter is a bool value that tells the application
|
||
|
|
to mount the filesystem in read only mode regaurdless if
|
||
|
|
you're mounting a snapshot dataset or not.
|