.TH APT-OSTREE.CONF 5 "2025-08-13" "apt-ostree 0.1.0" "File Formats"
.SH NAME
apt-ostree.conf \- Configuration file for apt-ostree
.SH SYNOPSIS
.B /etc/apt-ostree/config.toml
.SH DESCRIPTION
The
.B apt-ostree.conf
file contains configuration settings for apt-ostree. The file is written in TOML
format and controls various aspects of the system's behavior.
.PP
If no configuration file is specified, apt-ostree will use default values.
.SH CONFIGURATION SECTIONS
.SS "[system]"
System-wide configuration settings.
.TP
.B data_dir = \fIPATH\fR
Path to the data directory (default: /var/lib/apt-ostree).
.TP
.B log_level = \fILEVEL\fR
Logging level: debug, info, warn, error (default: info).
.TP
.B daemon_socket = \fIPATH\fR
Path to the daemon socket (default: /run/apt-ostreed.sock).
.TP
.B max_deployments = \fINUMBER\fR
Maximum number of deployments to keep (default: 3).

.SS "[ostree]"
OSTree-specific configuration.
.TP
.B repo_path = \fIPATH\fR
Path to the OSTree repository (default: /ostree/repo).
.TP
.B deploy_path = \fIPATH\fR
Path to deployments (default: /ostree/deploy).
.TP
.B booted_deployment = \fINAME\fR
Name of the currently booted deployment.
.TP
.B default_branch = \fIBRANCH\fR
Default branch for deployments (default: debian/13/amd64).

.SS "[apt]"
APT package management configuration.
.TP
.B sources_list = \fIPATH\fR
Path to APT sources list (default: /etc/apt/sources.list).
.TP
.B apt_conf = \fIPATH\fR
Path to APT configuration (default: /etc/apt/apt.conf).
.TP
.B cache_dir = \fIPATH\fR
APT cache directory (default: /var/cache/apt).
.TP
.B state_dir = \fIPATH\fR
APT state directory (default: /var/lib/apt).

.SS "[security]"
Security and authentication settings.
.TP
.B polkit_enabled = \fIBOOL\fR
Enable Polkit authentication (default: true).
.TP
.B require_auth = \fIBOOL\fR
Require authentication for privileged operations (default: true).
.TP
.B allowed_users = \fIUSERS\fR
List of users allowed to perform operations.
.TP
.B allowed_groups = \fIGROUPS\fR
List of groups allowed to perform operations.

.SS "[daemon]"
Daemon service configuration.
.TP
.B user = \fIUSER\fR
User to run the daemon as (default: root).
.TP
.B group = \fIGROUP\fR
Group to run the daemon as (default: root).
.TP
.B pid_file = \fIPATH\fR
Path to PID file (default: /run/apt-ostreed.pid).
.TP
.B log_file = \fIPATH\fR
Path to log file (default: /var/log/apt-ostreed.log).

.SS "[development]"
Development and debugging features.
.TP
.B enable_dev_commands = \fIBOOL\fR
Enable development commands (default: false).
.TP
.B debug_mode = \fIBOOL\fR
Enable debug mode (default: false).
.TP
.B test_mode = \fIBOOL\fR
Enable test mode (default: false).

.SH EXAMPLE CONFIGURATION
.nf
# System configuration
[system]
data_dir = "/var/lib/apt-ostree"
log_level = "info"
max_deployments = 5

# OSTree configuration
[ostree]
repo_path = "/ostree/repo"
deploy_path = "/ostree/deploy"
default_branch = "debian/13/amd64"

# APT configuration
[apt]
sources_list = "/etc/apt/sources.list"
cache_dir = "/var/cache/apt"

# Security configuration
[security]
polkit_enabled = true
require_auth = true
allowed_users = ["admin", "root"]

# Daemon configuration
[daemon]
user = "root"
group = "root"
log_file = "/var/log/apt-ostreed.log"

# Development features
[development]
enable_dev_commands = false
debug_mode = false
.fi

.SH FILES
.TP
.B /etc/apt-ostree/config.toml
Default configuration file location.
.TP
.B /etc/apt-ostree/
Configuration directory.
.TP
.B ~/.config/apt-ostree/config.toml
User-specific configuration file.

.SH ENVIRONMENT
.TP
.B APT_OSTREE_CONFIG
Override the default configuration file path.

.SH NOTES
The configuration file is read when apt-ostree starts. Changes to the
configuration file require restarting the daemon to take effect.
.PP
Boolean values can be specified as true/false, yes/no, or 1/0.
.PP
Paths can be absolute or relative to the configuration file location.

.SH BUGS
Report bugs to the project issue tracker at
.IR https://github.com/robojerk/apt-ostree/issues .

.SH AUTHOR
Written by Robojerk <robojerk@example.com>.

.SH COPYRIGHT
Copyright \(co 2025 Robojerk. License GPL-3.0-or-later: GNU GPL version 3 or later
<https://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

.SH SEE ALSO
.BR apt-ostree (1),
.BR apt-ostree-dev (1),
.BR ostree (1),
.BR apt (8)