NAME
bcfg2.conf - configuration parameters for bcfg2
DESCRIPTION
bcfg2.conf includes configuration parameters for the bcfg2 server and
client.
FILE FORMAT
The file is INI-style and consists of sections and options. A section
begins with the name of the sections in square brackets and continues
until the next section begins.
Options are specified in the form ’name = value’.
The file is line-based each newline-terminated line represents either a
comment, a section name or an option.
Any line beginning with a hash (#) is ignored, as are lines containing
only whitespace.
SERVER OPTIONS
These options are only necessary on the Bcfg2 server. They are
specified in the [server] section of the configuration file.
repository
Specifies the path to the Bcfg2 repository containing all of the
configuration specifications. The repository should be created
using the bcfg2-init command.
svn Set this to yes if the repository is SVN managed.
structures
A comma-delimited list of all the enabled structures plugins.
Currently available plugins are Base, Bundler, and SGenshi.
Defaults to Bundler and Base.
generators
A comma-delimited list of all enabled generator plugins.
Currently available plugins are Actions, Cfg, Deps, Hostbase,
Pkgmgr, Rules, SSHbase, TCheetah, and TGenshi. Defaults to
SSHbase, Cfg, Pkgmgr, and Rules.
plugins
A comma-delimited list of enabled server plugins. Currently
available plugins are DBStats.
bundles
A list of enabled bundles
filemonitor
The file monitor used to watch for changes in the repository.
Values of ’gamin’, ’fam’, or ’pseudo’ are valid.
STATISTICS OPTIONS
Server-only, specified in the [statistics] section. These options
control the statistics collection functionality of the server.
database_engine
The database engine used by the statistics module. One of either
’postgresql’, ’mysql’, ’sqlite3’, or ’ado_mssql’.
database_name
The name of the database to use for statistics data. If
’database_engine’ is set to ’sqlite3’ this is a file path to
sqlite file and defaults to $REPOSITORY_DIR/etc/brpt.sqlite
database_user
User for database connections. Not used for sqlite3.
database_password
Password for database connections. Not used for sqlite3.
database_host
Host for database connections. Not used for sqlite3.
database_port
Port for database connections. Not used for sqlite3.
COMMUNICATION OPTIONS
Specified in the [communication] section. These options define settings
used for client-server communication.
password
Required on both the server and clients. On the server, sets the
password clients need to use to communicate. On a client, sets
the password to use to connect to the server.
key A server-only option. The file system path to the server’s SSL
key. Required if using xmlrpc/ssl for communication.
protocol
Communication protocol to use. Defaults to xmlrpc/ssl.
retries
A client-only option. Number of times to retry network
communication.
agent-port
The TCP port on which to bind for agent mode.
user A client-only option. The UUID of the client.
fingerprint
A client-only option. The fingerprint of the server’s SSL
certificate. Obtainable by running ’bcfg2-admin fingerprint’.
COMPONENT OPTIONS
Specified in the [components] section.
bcfg2 URL of the server. On the server this specifies which interface
and port the server listens on. On the client, this specifies
where the client will attempt to contact the server. eg: bcfg2 =
https://10.3.1.6:6789
encoding
Text encoding of configuration files. Defaults to the system
default encoding.
LOGGING OPTIONS
Specified in the [logging] section. These options control the server
logging functionality.
path Server log file path.
SEE ALSO
bcfg2(1), bcfg2-server(8)
bcfg2.conf(5)