Deploy Configuration File

Name

deploy.conf — Configuration file for Deploy.

DESCRIPTION

Deploy uses an optional configuration file deploy.conf located at /etc/deploy/. The location of this file can be overridden using the -c or --config Deploy command line option.

ELEMENTS

All elements are optional.

lib-path

By default, Deploy searches directories listed on the system path to locate Deploy modules. The lib-path element allows specifying additional directory PATHs in which one or more Deploy modules can be found. Multiple path elements are allowed. Corresponds to the --lib-path command-line option.

<lib-path>PATH</lib-path>
disable-module

Name of a core module to disable by default. Multiple enable-module elements are allowed. Corresponds to the --disable command-line option.

<disable-module>MODULE</disable-module>
enable-module

Name of an extension module to enable by default. Multiple enable-module elements are allowed. Corresponds to the --enable command-line option.

<enable-module>MODULE</enable-module>
log-file

Directory and filename PATH to which Deploy writes logging information. The default path is /var/log/deploy.log. Deploy creates the log file if none exists. Corresponds to the --log-file command-line option.

<log-file>PATH</log-file>
share-path

Directory PATH in which one or more of Deploy's shared files can be found; the directory contains a hierarchy enabling Deploy to extract files for schema *.rng. The default path is /usr/share/deploy. Multiple path elements are allowed. Deploy searches paths in the order specified.

Corresponds to the --share-path command-line option.

<share-path>PATH</share-path>
templates-path

Directory PATH in which template files can be found. The default path is /usr/share/deploy/templates. Multiple templates-path elements are allowed. Deploy searches paths in the order specified.

Corresponds to the %{templates-dir} global run-time macro.

<templates-path>PATH</templates-path>
debug

Boolean value which enables or disables debug mode in Deploy. Enabling debug mode causes exception tracebacks, which are normally visible only in the log file, to be additionally displayed on the command line. Corresponds to the --debug command-line option. The default value is 'False'.

<debug>BOOLEAN</debug>
offline

Boolean value instructing Deploy to retrieve files from the cache, if available. Corresponds to the --offline command line option. The default value is 'False'.

<offline>BOOLEAN</offline>

CACHE ELEMENTS

Deploy caches data across sessions for improved performance. The cache element allows specifying cache-related options.

path

The path child element specifies where Deploy stores both shared and per-definition cache data. The default is /var/cache/deploy.

<cache>
    <path>CACHEDIR</path>
</cache>
max-size

The max-size child element specifies the maximum size for the shared cache located at CACHEDIR/.cache. The shared cache contains a copy of all files downloaded by Deploy. There is no human-readable form of the shared cache. The default size is 30GB. The recommended minimum size is 5GB. The default suffix is GB; other available suffixes are MB, GiB and TB.

Deploy deletes files from the shared cache on a least-recently used basis.

<cache>
    <max-size>TEXT</max-size>
</cache>

VARIABLES

Deploy element values, where indicated, use the variables below.

BOOLEAN

BOOLEAN is one of the following values: Yes, yes, True, true, On, on, 1, No, no, False, false, Off, off, 0.

CACHEDIR

CACHEDIR is the directory location where Deploy stores shared and per-directory cache data.

PATH

PATH is a local absolute or relative file path. Deploy resolves relative paths from the current working directory.

TEXT

TEXT is a string value. The description of each element explains that element's expected values or acceptable variations.

EXAMPLES

An example Deploy configuration file with multiple listings for share-path and lib-path elements is shown below:

<repo>
    <share-path>/usr/share</share-path>
    <share-path>~/deploy/share</share-path>
    <lib-path>/usr/lib</lib-path>
    <lib-path>~/deploy/lib</lib-path>
    <log-file>~/deploy.log</log-file>
    <cache>
        <path>~/deploy/cache</path>
        <max-size>5GB</max-size>
    </cache>
</repo>
    

BUGS

See the web site at http://www.deployproject.org for contact and support information.

AUTHOR

Deploy Foundation