Env TOML Configuration#

The Env TOML file is used to configure the environment for docbuild. It allows you to specify various settings such as server configuration, paths, and other environment-specific parameters.

[server]#

Deals with all config about server settings

name
Type:

str

Default:

doc-example-com

Name of the server, used for logging and cache paths

role
Type:

str

Default:

production

Role of the server, used for logging and other purposes. Possible values: “production”, “staging”, “development”

host
Type:

str

Default:

127.0.0.1

Hostname or IP address to bind the server to.

port
Type:

int

Default:

80

Port number to listen on. Uncomment and set to enable.

enable_mail
Type:

bool

Default:

true

Whether to enable email notifications. Set to true to enable.

[config]#

General configuration

default_lang
Type:

str

Default:

en-us

Default language for the documentation.

languages
Type:

list[str]

Default:

['de-de', 'en-us', 'es-es', 'fr-fr', 'ja-jp', 'ko-kr', 'pt-br', 'zh-cn']

A list of all supported languages.

canonical_url_domain
Type:

str

Default:

https://docs.example.com

The canonical domain used to construct absolute URLs.

[paths]#

Defines several paths Paths can hold placeholders in brackets. Key naming convention:

  • Suffix _dir: contains only directory paths

  • Suffix _path: contains directory and filename paths

  • Suffix _dyn: contains placeholders that are replaced at runtime

root_config_dir
Type:

str

Default:

/etc/docbuild

The root directory where all configuration files are stored.

jinja_dir
Type:

str

Default:

{root_config_dir}/jinja-doc-suse-com

Path to the directory containing Jinja templates.

config_dir
Type:

str

Default:

{root_config_dir}/config.d

Path to the directory for additional configuration files.

server_rootfiles_dir
Type:

str

Default:

{root_config_dir}/server-root-files-doc-suse-com

Path to the directory containing server root files like robots.txt.

base_cache_dir
Type:

str

Default:

/var/cache/docserv

The base directory for storing cached data.

base_server_cache_dir
Type:

str

Default:

{base_cache_dir}/{server.name}

The server-specific cache directory, derived from base_cache_dir and server name.

base_tmp_dir
Type:

str

Default:

/var/tmp/docbuild

The base directory for temporary files.

repo_dir
Type:

str

Default:

/data/docserv/repos/permanent-full/

The directory where permanent full repositories are stored.

tmp_repo_dir
Type:

str

Default:

/data/docserv/repos/temporary-branches/

The directory for storing temporary repositories from branches.

meta_cache_dir
Type:

str

Default:

{base_cache_dir}/{server.name}/meta

The directory for caching metadata.

[paths.tmp]#

Defines temporary paths Paths can hold placeholders in brackets.

tmp_base_dir
Type:

str

Default:

{paths.base_tmp_dir}

The base directory for temporary files, referencing paths.base_tmp_dir.

tmp_dir
Type:

str

Default:

{tmp_base_dir}/doc-example-com

A server-specific temporary directory.

tmp_metadata_dir
Type:

str

Default:

{tmp_dir}/metadata

A temporary directory for storing metadata during processing.

tmp_deliverable_dir
Type:

str

Default:

{paths.tmp.tmp_dir}/deliverable/

A temporary directory for storing deliverables.

tmp_build_base_dir
Type:

str

Default:

{tmp_dir}/build

The base directory for build outputs.

tmp_build_dir_dyn
Type:

str

Default:

{{product}}-{{docset}}-{{lang}}

A dynamic template for creating build-specific directories.

tmp_out_dir
Type:

str

Default:

{tmp_dir}/out/

The final temporary output directory before deployment.

log_dir
Type:

str

Default:

{tmp_dir}/log/

The directory for storing log files.

tmp_deliverable_name_dyn
Type:

str

Default:

{{product}}_{{docset}}_{{lang}}_XXXXXX

A dynamic template for naming temporary deliverables.

[paths.target]#

Defines target paths

target_base_dir
Type:

str

Default:

doc@10.100.60.1:/srv/docs

The base path for the deployment target, including server and directory.

target_dir_dyn
Type:

str

Default:

{{product}}

A dynamic template for the final target directory on the remote server.

backup_dir
Type:

str

Default:

/data/docbuild/external-builds/

The directory where backups of external builds are stored.

[build]#

[build.daps]#

Configuration for daps

command
Type:

str

Default:

daps -vv

The base command to execute DAPS with verbose output.

meta
Type:

str

Default:

daps -vv metadata --output {{output}}

The DAPS command to extract metadata, with a placeholder for the output file.

[build.container]#

Configuration for container

container
Type:

str

Default:

registry.opensuse.org/documentation/containers/15.6/opensuse-daps-toolchain:latest

The full name of the container image to be used for the build environment.

[xslt-params]#

Replaces /etc/docserv/xslt-params-doc-suse-com.txt file These keys are considered as XSLT parameters and passed to the transformation process

homepage
Type:

str

Default:

https://documentation.suse.com/

The URL for the main homepage link in the documentation.

overview-page
Type:

str

Default:

https://documentation.suse.com/

The URL for the documentation overview page.

overview-page-title
Type:

str

Default:

documentation.suse.com

The title displayed for the overview page link.

external.js.onlineonly
Type:

str

Default:

n/a

Path to an external JavaScript file that is only included in the online version.

twittercards.twitter.account
Type:

str

Default:

n/a

The Twitter username to associate with Twitter Cards.

generate.json-ld
Type:

int

Default:

n/a

A flag to enable or disable the generation of JSON-LD structured data (1 for true).

search.description.length
Type:

int

Default:

n/a

The maximum character length for search result descriptions.

socialmedia.description.length
Type:

int

Default:

n/a

The maximum character length for descriptions used in social media sharing.