Conary:Configuration

From rPath Wiki

Conary's configuration may be defined in the configuration file conaryrc, which can exist in three possible locations:

The current working directory: ./conaryrc
The user's home directory: $HOME/.conaryrc
The system configuration directory: /etc/conaryrc

Configuration directives consisting of "name value" pairs specified in ./conaryrc override those specified in $HOME/.conaryrc which in turn, override those specified in /etc/conaryrc.

The following table lists valid conaryrc file directives, their default values, and a description of each directive's purpose; directives appearing in bold text are most commonly required.

Directive	Default Value	Description
`archDirs`	`/etc/conary/arch`, `/etc/conary/distro/arch`, `~/.conary/arch`	Specify directories containing architecture definition files
`autoResolve`	False	Whether to resolve dependencies by default when installing
`autoResolvePackages`	True	Conary will install the package a component dependency is resolved to when this option is set to `True`.
`buildFlavor`	None	The flavor that Conary will use when building troves.
`buildLabel`	None	The default label for troves during source code operations (checkout, diff, etc) and for cooks.
`buildPath`	`~/conary/builds`	The path packages are built under.
`cleanAfterCook`	True	Whether to remove the contents of the build directory created by a successful `cvc cook` operation.
`contact`	None	Contact information for the builder of the package; can be any string, but it should be an email address or a URL.
`context`	None	Specify a particular context to use by default, for example in the `conaryrc` of a specific directory used in operations pertaining to a specific project.
`dbpath`	`/var/lib/conarydb`	The path for the system database (relative to root)
`debugExceptions`	False	Normally errors in Conary itself cause an error message to be displayed and Conary exits. If this is set to true the python debugger is invoked when the exception occurs.
`debugRecipeExceptions`	False	Normally errors in recipes cause an error message to be displayed and Conary exits. If this is set to true the python debugger is invoked when the exception occurs.
`defaultMacros`	`/etc/conary/macros`	Specify default location of the macros file
`downloadRateLimit`	0	Specify a bandwidth limit (in bytes per second) for Conary's download rate
`emergeUser`	emerge	User to switch to for `conary emerge` operations
`entitlementDirectory`	`/etc/conary/entitlements`	Specify directories where Conary should expect to find entitlements
`environment`	None	Specify an environment variable and its associated value to set (or, if no value is provided, the environment variable to unset) while building packages. These may be set within contexts, and the values may include macros.
`excludeTroves`	None	A space-separated list of regular expressions. Troves whose names match any of the regular expressions in this list are only installed if they are specifically requested.
`flavor`	None	The flavor that Conary will use to find troves to install when the trove is not yet installed on the system, or when updating troves, to fill in any flavors not specified in the trove. It is specified using the same syntax as flavors are specified on the command line.
`fullFlavors`	False	By default, Conary tries to make a guess at what parts of a trove's flavor will be relevant to you by looking at what troves you have installed, your install flavors, and the other troves with the same name being displayed. Setting this directive to `True` causes Conary to display the full flavor.
`FullVersions`	False	Full version strings are displayed instead of abbreviated version numbers.
`installLabelPath`	None	The labels from which to install and query, specified in the order of use. If installLabelPath is not set, Conary will exit with an error message.
`interactive`	False	If set to True, Conary will ask for confirmation before performing actions that modify system or repository state.
`localRollbacks`	False	With this directive set to `True`, Conary will preserve files from changes locally so that a rollback might be performed without access to a repository.
`logFile`	`/var/log/conary`, `~/.conary/log`	Specify Conary's log output file
`lookaside`	`~/conary/cache`	The transient lookaside cache, used during building of packages.
`macros`	None	Specify macros which will override the values of macros in Conary recipes.
`mirrorDirs`	`/etc/conary/mirrors`	Specify directories containing mirror list files used by `mirror://` URLs. The default mirror lists located in `/etc/conary/mirrors` include `debian`, `fedora`, `gentoo`, and `sourceforge`.
`name`	None	The name of the packager (used for changelog entries)
`pinTroves`	None	Specify a list of troves to pin by default
`policyDirs`	`/usr/lib/conary/policy`, `/etc/conary/policy`, `~/.conary/policy`	Specify location of Conary policy directories
`proxy`	None	used to define the proxy that Conary will use. This can be an authenticated proxy, a secure proxy, or standard proxy. For more information, see Proxy Information
`pubRing`	`/etc/conary/pubring.gpg`, `~/.gnupg/pubring.gpg`	The filename of the OpenPGP Keyring to refer to for signature keys
`quiet`	True	When this directive is set to `True`, Conary's output is less verbose.
`recipeTemplate`	None	Specify a recipe template (useful in a context) for use with the `cvc newpkg` command.
`recipeTemplateDirs`	`~/.conary/recipeTemplates`, `/etc/conary/recipeTemplates]]`	Specify directory paths to search for recipe templates.
`repositoryMap`	`http://hostname/conary/`	Maps a hostname from a label to a full URL for a networked repository. Multiple lines can be provided.
`resolveLevel`	1	Determines the level of effort conary will put into resolving dependencies. resolveLevel 1: Attempt to resolve dependencies by adding new troves that fulfill those missing dependencies. resolveLevel 2: If updating trove 'a' removes a dependency needed by trove 'b', attempt to update 'b' to solve the dependency issue.
`root`	`/`	The path to install files into.
`show Labels`	False	If set to `True`, Conary displays <label>/<revision> instead of abbreviated version numbers.
`showComponents`	False	Whether to display components
`signatureKey`	None	Key fingerprint of default OpenPGP key used for packet signatures. If not specified, troves will not be signed.
`signatureKeyMap`	None	Provides a mechanism to map an OpenPGP Key from a local keyring to a repository.
`sourceSearchDir`	Current working directory (`.`)	An extra path (within the root) to search for source files
`threaded`	True	Whether to execute in multi-threaded mode
`tmpDir`	`/var/tmp`	Directory for temporary files
`trustThreshold`	0	Specify a threshold of trust for trove signatures, with accepted values being: 0 - Any valid signature is trusted. 4 - Marginal trust of signatures. 5 - Full trust of signatures. 6 - Signatures are your own.
`updateThreshold`	10	Defines the upper limit on the number of unrelated troves that will be downloaded at one time from the repository.
`uploadRateLimit`	0	Specify a bandwidth limit (in bytes per second) for Conary's download rate
`useDirs`	`/etc/conary/use`, `/etc/conary/distro/use`, `~/.conary/use`	Specify location of use flag file directories
`user`	None	Each entry maps a hostname (or set of hostnames specified as a glob) to the username and password to use (Conary will prompt interactively if a necessary user entry is missing). Note that "hostname", in this context, refers to the hostname part of a label, not the hostname used to access a repository. (which may not be the same if a repositoryMap is being used)

Example

Here's a useful example to copy to $HOME/.conaryrc and modify:

buildLabel       conary.example.com@rpl:devel
buildPath        /home/janedoe/conary/builds
contact          Jane.Doe@example.com
installLabelPath conary.rpath.com@rpl:devel contrib.rpath.org@rpl:devel
lookaside        /home/janedoe/conary/cache
name             Jane Doe
repositoryMap    conary.example.com https://conary.example.com/path/for/conary/
user             conary.example.com example-username example-password
user             *.rpath.org rBuilder-Online-username rBuilder-Online-password
#root            /home/janedoe/conary/testroot
signatureKey     F7440D78FE813C882212C2BF8AC2828190B1E477