Repotool
Configuration
How to configure Repotool using configuration files.
Overview
To specify the default behavior of Repotool, (optional) configuration files can be provided.
If there are matching config options and command line parameters, the command line parameters override the specified config options.
To view the current in use configuration, you can use the config show command or view the configuration files in the source code.
CLI (repotool-cli.yaml)
repotool-cli_sample.yaml
verbose: false
quiet: false
repotool_config_file_path: "repotool.yaml"
console_output:
enable_rich_output: true
View the recent sample configuration.
quiet
boolean
Default to
false - Do not print any program output (where possible).- Defaults to
false
verbose
boolean
Default to
false - Print additional verbose output; ignored when quiet is enabled.- Defaults to
false
repotool_config_file_path
string
Path (absolute/relative) to the
repotool-cli.yaml, containing Repotool configuration.- Defaults to
repotool.yaml
console_output
enable_rich_output
boolean
Whether output should be rich, e.g.: bold, with color, etc.
- Defaults to
true
Repotool (repotool.yaml)
repotool_sample.yaml
data:
assets_directory_path: "repo/assets"
build_directory_path: "repo/build"
git_directory_path: "repo/git"
metadata_directory_path: "repo/metadata"
plugin_directory_path: "plugins"
repo_directory_path: "repo/repo"
repo_icons_directory_path: "repo/repo/icons"
temporary_directory_path: "repo/tmp"
keystore:
keystore_path: "repo/katastima.p12"
keystore_password: "changeme"
key_alias: "katastima.org"
key_password: "changeme"
key_subject_line: "C=AT, ST=Kärnten, L=Wolfsberg, O=Katastima, OU=Katastima, CN=katastima.org,\
\ emailAddress=katastima@katastima.org"
repo:
version: 30000
name: "Katastima Repository"
icon: "icon.png"
address: "https://katastima.org/repo"
description: "TODO: change me, please"
frontendAddress: null
mirrors: null
plugins:
expose_loaded_plugins: false
View the recent sample configuration.
data
assets_directory_path
path
Path to the assets directory.
- Defaults to
repo/assets
build_directory_path
path
Path to the build directory.
- Defaults to
repo/build
git_directory_path
path
Path to the git directory.
- Defaults to
repo/git
metadata_directory_path
path
Path to the metadata directory.
- Defaults to
repo/metadata
plugin_directory_path
path
Path to the plugins directory.
- Defaults to
plugins
repo_directory_path
path
Path to the repo directory.
- Defaults to
repo/repo
repo_icons_directory_path
path
Path to the repo icons directory.
- Defaults to
"$repo_directory_path/icons" - e.g.:
repo/repo/icons"
temporary_directory_path
path
Path to the temporary directory.
- Defaults to
repo/tmp
keystore
keystore_path
path
Path to the keystore.
- Default to
repo/katastima.p12
keystore_password
string
The password of the keystore.
- Defaults to
changeme
key_alias
string
The alias of the key within the keystore.
- Defaults to
katastima.org
key_password
string
The password of the key within the keystore.
- Defaults to
changeme
key_subject_line
string
The subject line of the key within the keystore.
- Defaults to
C=AT, ST=Kärnten, L=Wolfsberg, O=Katastima, OU=Katastima, CN=katastima.org, emailAddress=katastima@katastima.org
repo
version
number
The version of the repository.
- Defaults to
30000
name
string
The name of the repository.
- Defaults to
Katastima Repository
description
string
The description of the repository.
- Defaults to
TODO: change me, please
address
string
The address of the repository (where it will be hosted).
- Defaults to
https://katastima.org/repo
icon
string
Name of the repository icon.
- Defaults to
icon.png
frontendAddress
string
The frontend address of the repository (where a repository browser for the repo is hosted).
- Defaults to
null
mirrors
array
An array containing mirrors of the repository.
- Defaults to
null
plugins
expose_loaded_plugins
boolean
Whether plugins loaded by Repotool should be added to
repo.json.- Defaults to
false