OSCRC(5)

NAME
oscrc - openSUSE Commander configuration file

The configuration file path is $XDG_CONFIG_HOME/osc/oscrc, which usually translates into ~/.config/osc/oscrc.

The configuration options are loaded with the following priority:

1.  environment variables: OSC_<uppercase_option> or OSC_<uppercase_host_alias>_<uppercase_host_option>

2.  command-line options

3.  oscrc config file

GENERIC OPTIONS

apiurl : str = "https://api.opensuse.org" Default URL to the API server. Credentials and other apiurl specific settings must be configured in a [$apiurl] config section or via API in an api_host_options entry.

AUTHENTICATION OPTIONS

sshkey : str A pointer to public SSH key that corresponds with a private SSH used for authentication:

•   keep empty for auto detection

•   path to the public SSH key

•   public SSH key filename (must be placed in ~/.ssh)

•   fingerprint of a SSH key (2nd column of ssh-add -l)

    NOTE: The private key may not be available on disk because it could be in a GPG keyring, on YubiKey or forwarded through SSH agent.

    TIP: To give osc a hint which ssh key from the agent to use during auto detection, append obs=<apiurl-hostname> to the private key's comment. This will also work nicely during SSH agent forwarding, because the comments get forwarded too.

•   To edit the key, run: ssh-keygen -c -f ~/.ssh/<private-key>

•   To query the key, run: ssh-keygen -y -f ~/.ssh/<private-key>

•   Example comment: <username@host> obs=api.example.com obs=api-test.example.com

    use_keyring : bool = 0 Enable keyring as an option for storing passwords.

VERBOSITY OPTIONS

quiet : bool = 0 Reduce amount of printed information to bare minimum. If enabled, automatically sets verbose to False.

verbose : bool = 0 Increase amount of printed information to stdout. Automatically set to False when quiet is enabled.

debug : bool = 0 Print debug information to stderr.

http_debug : bool = 0 Print HTTP traffic to stderr. Automatically set to True when``http_full_debug`` is enabled.

http_full_debug : bool = 0 [CAUTION!] Print HTTP traffic incl. authentication data to stderr. If enabled, automatically sets http_debug to True.

http_manual_approve : bool = 0 A debugging option. Manually approve all requests except GET and HEAD.

post_mortem : bool = 0 Jump into a debugger when an unandled exception occurs.

traceback : bool = 0 Print full traceback to stderr when an unandled exception occurs.

show_download_progress : bool = 1 Show download progressbar.

CONNECTION OPTIONS

http_retries : int = 3 Number of retries on HTTP error.

cookiejar : str = "~/.local/state/osc/cookiejar" Path to a cookie jar that stores session cookies.

SCM OPTIONS

realname : str Name of the user passed to the vc tool via VC_REALNAME env variable.

email : str Email of the user passed to the vc tool via VC_MAILADDR env variable.

local_service_run : bool = 1 Run local services during commit.

getpac_default_project : str = "openSUSE:Factory" The default project for osc getpac and osc bco. The value is a space separated list of strings.

exclude_glob : space-separated-list = ".osc CVS .svn .* _linkerror *~ #*# *.orig *.bak *.changes.vctmp.*" Space separated list of files ignored by SCM. The files can contain globs.

exclude_files : space-separated-list Files that match the listed glob patterns get skipped during checkout.

include_files : space-separated-list Files that do not match the listed glob patterns get skipped during checkout. The exclude_files option takes priority over include_files.

checkout_no_colon : bool = 0 Use '/' as project separator instead the default ':' and create corresponding subdirs. If enabled, it takes priority over the project_separator option.

project_separator : str = ":" Use the specified string to separate projects.

check_filelist : bool = 1 Check for untracked files and removed files before commit.

do_package_tracking : bool = 1 Track packages in parent project's .osc/_packages.

checkout_rooted : bool = 0 Prevent checking out projects inside other projects or packages.

status_mtime_heuristic : bool = 0 Consider a file with a modified mtime as modified.

linkcontrol : bool = 0

BUILD OPTIONS

build_repository : str = "openSUSE_Factory" The default repository used when the repository argument is omitted from osc build.

buildlog_strip_time : bool = 0 Strip the build time from the build logs.

packagecachedir : str = "/var/tmp/osbuild-packagecache" The directory where downloaded packages are stored. Must be writable by you.

no_verify : bool = 0 Disable signature verification of packages used for build.

builtin_signature_check : bool = 1 Use the RPM's built-in package signature verification.

disable_hdrmd5_check : bool = 0 Disable hdrmd5 checks of downloaded and cached packages in osc build. It is recommended to keep the check enabled.

OBS builds the noarch packages once per binary arch. Such noarch packages are supposed to be nearly identical across all build arches, any discrepancy in the payload and dependencies is considered a packaging bug. But to guarantee that the local builds work identically to builds in OBS, using the arch-specific copy of the noarch package is required. Unfortunatelly only one of the noarch packages gets distributed and can be downloaded from a local mirror. All other noarch packages are available through the OBS API only. Since there is currently no information about hdrmd5 checksums of published noarch packages, we download them, verify hdrmd5 and re-download the package from OBS API on mismatch.

The same can also happen for architecture depend packages when someone is messing around with the source history or the release number handling in a way that it is not increasing.

If you want to save some bandwidth and don't care about the exact rebuilds you can turn this option on to disable hdrmd5 checks completely.

REQUEST OPTIONS

include_request_from_project : bool = 1 When querying requests, show also those that originate in the specified projects.

request_list_days : int = 0 Limit the age of requests shown with osc req list to the given number of days.

This is only the default that can be overridden with osc request list -D <VALUE>. Use 0 for unlimited.

check_for_request_on_action : bool = 1 Check for pending requests after executing an action (e.g. checkout, update, commit).

request_show_interactive : bool = 0 Show requests in the interactive mode by default.

print_web_links : bool = 0 Print links to Web UI that can be directly pasted to a web browser where possible.

request_show_source_buildstatus : bool = 0 Print the buildstatus of the source package. Works only with osc request show and the interactive review.

submitrequest_accepted_template : str Template message for accepting a request.

Supported substitutions: %(reqid)s, %(type)s, %(who)s, %(src_project)s, %(src_package)s, %(src_rev)s, %(tgt_project)s, %(tgt_package)s

Example:

    Hi %(who)s, your request %(reqid)s (type: %(type)s) for %(tgt_project)s/%(tgt_package)s has been accepted. Thank you for your contribution.

submitrequest_declined_template : str Template message for declining a request.

Supported substitutions: %(reqid)s, %(type)s, %(who)s, %(src_project)s, %(src_package)s, %(src_rev)s, %(tgt_project)s, %(tgt_package)s

Example:

    Hi %(who)s, your request %(reqid)s (type: %(type)s) for %(tgt_project)s/%(tgt_package)s has been declined because ...

request_show_review : bool = 0 Review requests interactively.

review_inherit_group : bool = 0 If a review was accepted in interactive mode and a group was specified, the review will be accepted for this group.

submitrequest_on_accept_action : str What to do with the source package if the request has been accepted. If nothing is specified the API default is used.

Choices: cleanup, update, noupdate

BUILD TOOL OPTIONS

build-jobs : int The number of parallel processes during the build. Defaults to the number of available CPU threads.

If the value is greater than 0 then it is passed as --jobs to the build tool.

build-type : str Type of the build environment passed the build tool as the --vm-type option:

•   <empty> chroot build

•   kvm KVM VM build (rootless, needs build-device, build-swap, build-memory)

•   xen XEN VM build (needs build-device, build-swap, build-memory)

•   qemu [EXPERIMENTAL] QEMU VM build

•   lxc [EXPERIMENTAL] LXC build

•   uml

•   zvm

•   openstack

•   ec2

•   docker

•   podman (rootless)

•   pvm

•   nspawn

    See build --help for more details about supported options.

    build-memory : int The amount of RAM (in MiB) assigned to a build VM.

    build-root : str = "/var/tmp/build-root%(dash_user)s/%(repo)s-%(arch)s" Path to the build root directory.

    Supported substitutions: %(repo)s, %(arch)s, %(project)s, %(package)s, %(apihost)s, %(user)s, %(dash_user)s where:

        - ``apihost`` is the hostname extracted from the currently used ``apiurl``.
        - ``dash_user`` is the username prefixed with a dash. If ``user`` is empty, ``dash_user`` is also empty.

    NOTE: The configuration holds the original unexpanded string. Call osc.build.get_build_root() with proper arguments to retrieve an actual path.

    Passed as --root <VALUE> to the build tool.

    build-shell-after-fail : bool = 0 Start a shell prompt in the build environment if a build fails.

    Passed as --shell-after-fail to the build tool.

    build-uid : str Numeric uid:gid to use for the abuild user. Neither of the values should be 0. This is useful if you are hacking in the buildroot. This must be set to the same value if the buildroot is re-used.

    Passed as --uid <VALUE> to the build tool.

    build-kernel : str The kernel used in a VM build.

    build-initrd : str The initrd used in a VM build.

    build-device : str The disk image used as rootfs in a VM build.

    Passed as --vm-disk <VALUE> to the build tool.

    build-vmdisk-filesystem : str The file system type of the disk image used as rootfs in a VM build. Supported values: ext3 (default), ext4, xfs, reiserfs, btrfs.

    Passed as --vm-disk-filesystem <VALUE> to the build tool.

    build-vmdisk-rootsize : int The size of the disk image (in MiB) used as rootfs in a VM build.

    Passed as --vm-disk-size to the build tool.

    build-swap : str Path to the disk image used as a swap for VM builds.

    Passed as --swap to the build tool.

    build-vmdisk-swapsize : int The size of the disk image (in MiB) used as swap in a VM build.

    Passed as --vm-swap-size to the build tool.

    build-vm-user : str The username of a user used to run QEMU/KVM process.

    icecream : int = 0 Use Icecream distributed compiler. The value represents the number of parallel build jobs.

    Passed as --icecream <VALUE> to the build tool.

    ccache : bool = 0 Enable compiler cache (ccache) in build roots.

    Passed as --ccache to the build tool.

    sccache : bool = 0 Enable shared compilation cache (sccache) in build roots. Conflicts with ccache.

    Passed as --sccache to the build tool.

    sccache_uri : str Optional URI for sccache storage.

    Supported URIs depend on the sccache configuration. The URI allows the following substitutions:

•   {pkgname}: name of the package to be build

    Examples:

•   <file:///var/tmp/osbuild-sccache>-{pkgname}.tar.lzop

•   <file:///var/tmp/osbuild-sccache>-{pkgname}.tar

•   redis://127.0.0.1:6379

    Passed as --sccache-uri <VALUE> to the build tool.

    no_preinstallimage : bool = 0 Do not use preinstall images to initialize build roots.

    extra-pkgs : space-separated-list Extra packages to install into the build root when building packages locally with osc build.

    This corresponds to osc build -x pkg1 -x pkg2 .... The configured values can be overriden from the command-line with -x ''.

    This global setting may leads to dependency problems when the base distro is not providing the package. Therefore using server-side cli_debug_packages option instead is recommended.

    Passed as --extra-packs <VALUE> to the build tool.

PATHS TO PROGRAMS

build-cmd : str = "/usr/bin/build" Path to the 'build' tool.

download-assets-cmd : str = "/usr/lib/build/download_assets" Path to the 'download_assets' tool used for downloading assets in SCM/Git based builds.

queryrecipe-cmd : str = "/usr/lib/build/queryrecipe" Path to the 'queryrecipe' tool.

queryconfig-cmd : str = "/usr/lib/build/queryconfig" Path to the 'queryconfig' tool.

obs-scm-bridge-cmd : str = "/usr/lib/obs/service/obs_scm_bridge" Path to the 'obs_scm_bridge' tool used for cloning scmsync projects and packages.

vc-cmd : str = "/usr/lib/build/vc" Path to the 'vc' tool.

su-wrapper : str = "sudo" The wrapper to call build tool as root (sudo, su -, ...). If empty, the build tool runs under the current user wich works only with KVM at this moment.

HOST OPTIONS

apiurl : str = "NotSet" URL to the API server.

aliases : space-separated-list Aliases of the apiurl.

user : str = "NotSet" Username for the apiurl.

credentials_mgr_class : str Fully qualified name of a class used to fetch a password.

pass : Password Password for the apiurl. May be empty if the credentials manager fetches the password from a keyring or sshkey is used.

sshkey : str A pointer to public SSH key that corresponds with a private SSH used for authentication:

•   keep empty for auto detection

•   path to the public SSH key

•   public SSH key filename (must be placed in ~/.ssh)

•   fingerprint of a SSH key (2nd column of ssh-add -l)

    NOTE: The private key may not be available on disk because it could be in a GPG keyring, on YubiKey or forwarded through SSH agent.

    TIP: To give osc a hint which ssh key from the agent to use during auto detection, append obs=<apiurl-hostname> to the private key's comment. This will also work nicely during SSH agent forwarding, because the comments get forwarded too.

•   To edit the key, run: ssh-keygen -c -f ~/.ssh/<private-key>

•   To query the key, run: ssh-keygen -y -f ~/.ssh/<private-key>

•   Example comment: <username@host> obs=api.example.com obs=api-test.example.com

    downloadurl : str Redirect downloads of packages used during build to an alternative location. This allows specifying a local mirror or a proxy, which can greatly improve download performance, latency and more.

    cafile : str The path to a file of concatenated CA certificates in PEM format. If specified, the CA certificates from the path will be used to validate other peers' certificates instead of the system-wide certificates.

    capath : str The path to a directory containing several CA certificates in PEM format. If specified, the CA certificates from the path will be used to validate other peers' certificates instead of the system-wide certificates.

    sslcertck : bool = 1 Whether to validate SSL certificate of the server. It is highly recommended to keep this option enabled.

    allow_http : bool = 0 Whether to allow plain HTTP connections. Using HTTP is insecure because it sends passwords and session cookies in plain text. It is highly recommended to keep this option disabled.

    http_headers : newline-separated-list Additional HTTP headers attached to each request. The format is HTTP headers separated with newlines.

    Example:

        http_headers =
            X-Header1: Value1
            X-Header2: Value2

    trusted_prj : space-separated-list List of names of the trusted projects. The names can contain globs. Please note that some repos may contain malicious packages that can compromise the build result or even your system!

    disable_hdrmd5_check : bool Disable hdrmd5 checks of downloaded and cached packages in osc build. It is recommended to keep the check enabled.

    OBS builds the noarch packages once per binary arch. Such noarch packages are supposed to be nearly identical across all build arches, any discrepancy in the payload and dependencies is considered a packaging bug. But to guarantee that the local builds work identically to builds in OBS, using the arch-specific copy of the noarch package is required. Unfortunatelly only one of the noarch packages gets distributed and can be downloaded from a local mirror. All other noarch packages are available through the OBS API only. Since there is currently no information about hdrmd5 checksums of published noarch packages, we download them, verify hdrmd5 and re-download the package from OBS API on mismatch.

    The same can also happen for architecture depend packages when someone is messing around with the source history or the release number handling in a way that it is not increasing.

    If you want to save some bandwidth and don't care about the exact rebuilds you can turn this option on to disable hdrmd5 checks completely.

    realname : str Name of the user passed to the vc tool via VC_REALNAME env variable.

    email : str Email of the user passed to the vc tool via VC_MAILADDR env variable.

Author
openSUSE project <opensuse-buildservice@opensuse.org>

Copyright
Contributors to the osc project