NAME

collection.conf — tix collection configuration

SYNOPSIS

/tix/collection.conf

DESCRIPTION

A tix collection created with tix-create(8) use the /tix/collection.conf configuration file inside the installation.

The collection.conf file is in the tix-vars(8) format, a subset of the sh(1) language with only variable assignments. collection.conf controls upgrades of the installation, contains release metadata, and user preferences such as which mirror to use. collection.conf can be modified with tix-create(8), or manually edited and syntax checked with tix-vars(8) -t.

collection.conf affects the behavior of programs such as tix-upgrade(8), tix-autoupgrade(8), tix-fetch(8), sysmerge(8), sysupgrade(8), and generally the rest of the tix package management.

The variables are as follows:

AUTOUPGRADE_INTERVAL

The number of seconds between tix-autoupgrade(8) checking for upgrades (if enabled). The value can optionally be suffixed with m for minutes, h for hours, or d for days. The default interval is 24h.

AUTOUPGRADE_OPTIONS

Additional options that tix-autoupgrade(8) (if enabled) will forward to tix-upgrade(8).

AUTOUPGRADE_REBOOT=[false | true]

Whether tix-autoupgrade(8) (if enabled) will automatically reboot upon successfully scheduling an upgrade for the next boot. The default value is false.

AUTOUPGRADE_REBOOT_TIME

If tix-autoupgrade(8) is enabled, and AUTOUPGRADE_REBOOT is true, then the reboot will happen at this time as a time parameter to shutdown(8) -r. The default is +1, one minute later.

BUILD_ID

The build identifier of the currently installed release. This value is used by tix-upgrade(8) to check if the installation is up to date.

This value is maintained by the tix package management and should not be edited.

FETCH_OPTIONS

Additional options that tix-upgrade(8) will pass to tix-fetch(8) by default. This variable is useful for setting the download verbosity and tuning the security of the download.

FORCE_MIRROR=[false | true]

Whether to use the MIRROR, even if is no longer listed as a mirror on the authoritative release information.

Warning: Enabling this option may cause upgrades to fail, since the mirror may be removed from the authoritative list if it's no longer up to date. The signature on the downloaded release is still verified, stale files are rejected, and the mirror must be up to date per the authoritative site.

MIRROR

The URL to the base of the preferred mirror for downloading packages from.

PLATFORM

The host triplet the installed packages are built for. Packages must have the same platform to be installed, or they must be platform independent.

It is not supported to change this value after the collection has been created.

PORTS=[false | true]

Whether to upgrade ports in sysmerge(8), sysupgrade(8), and tix-upgrade(8). If set to false, the administrator is personally responsible for keeping the system and ports synchronized across ABI changes. The default value is true.

PREFIX

The location the collection will be located at runtime. Packages must have the same prefix to be installed, or they must be location independent.

It is not supported to change this value after the collection has been created.

RELEASE_URL

The URL to the authoritative and signed channel/release information as created with tix-release(8). It ordinarily points to the current version on the appropriate channel, such that upgrades to new releases are available.

This value is maintained by the tix package management and should generally not be changed, except where explicitly supported. It is possible to switch to another channel or to fix the installation to a particular release, per the appropriate support rules for the channels and releases.

SYSTEM=[false | true]

Whether to upgrade the system in sysmerge(8), sysupgrade(8), and tix-upgrade(8). If set to false, the administrator is personally responsible for keeping the system and ports synchronized across ABI changes. The default value is true, if a system package is installed, and false otherwise .

TIX_COLLECTION_VERSION

The version of the tix collection's metadata. Currently this value must be 3.

This value is maintained by the tix package management and should not be edited.

EXAMPLES

An example collection.conf with a preferred mirror, configured to automatically upgrade every day and reboot at 04:30 AM:

TIX_COLLECTION_VERSION=3
BUILD_ID=578501924cd5463da9f3cf1e775924970607e504
PLATFORM=x86_64-sortix
PREFIX=
RELEASE_URL=https://example.com/local/channel/stable/1.0
MIRROR=https://cdn.example.net/local
AUTOUPGRADE_REBOOT=true
AUTOUPGRADE_REBOOT_TIME=04:30

The tix-autoupgrade(8) daemon can be enabled by running:

service autoupgrade enable

SEE ALSO

upgrade.conf(5), sysmerge(8), sysupgrade(8), tix-create(8), tix-fetch(8), tix-upgrade(8), tix-vars(8)

HISTORY

The collection.conf format originally appeared in Sortix 0.8. It was changed to the tix-vars(8) format and merged with /etc/upgrade.conf in Sortix 1.1.