---
name: "plainbox.conf"
section: "5"
platform: "linux"
package: "plainbox"
version: "0.25-1"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/plainbox.conf"
---

# plainbox.conf(5)

plainbox configuration file

## NAME

plainbox.conf - plainbox configuration file

## SYNOPSIS

**/etc/xdg/plainbox.conf**

**$XDG\_CONFIG\_HOME/plainbox.conf**

## DESCRIPTION

Plainbox (and its derivatives) uses a configuration system composed of variables arranged in sections. All configuration files follow the well-known INI-style syntax. While Plainbox itself is not really using any variables, knowledge of where those can be defined is useful for working with derivative applications, such as Checkbox.

### The \[environment\] section

The **\[environment\]** section deserves special attention. If a job advertises usage of environment variable **FOO** (by using the *environ: FOO* declaration) and **FOO** is not available in the environment of the user starting plainbox, then the value is obtained from the **\[environment\]** section. This mechanism is useful for distributing both site-wide and per-user configuration for jobs.

## FILES

**/etc/xdg/plainbox.conf**

System-wide configuration file (lowest priority).

**$XDG\_CONFIG\_HOME/plainbox.conf**

Per-user configuration (highest priority).

## EXAMPLES

/etc/xdg/plainbox.conf:

```
[environment]
OPEN_BG_SSID=my-ap-ssid
```

## SEE ALSO

**plainbox-check-config** (1)

## AUTHOR

Zygmunt Krynicki & Checkbox Contributors

## COPYRIGHT

2012-2014 Canonical Ltd