UPGRADE.CONF(5)

NAME
upgrade.conf - upgrade configuration

SYNOPSIS
/etc/upgrade.conf

DESCRIPTION
upgrade.conf controls the actions taken by sysupgrade(8) during a system upgrade as described in upgrade(7). The file allows customizing whether the system itself is replaced, whether new ports are installed, whether the new source code is installed and what happens to the old source code. It also records information about the system such as how the system is booted. The file is created automatically by sysinstall(8) as part of installation(7) to match what was installed.

The file also controls the actions of tix(8) when upgrading releases and installing ports.

Developers may wish to customize what happens to /src on a system upgrade. The new source code can be installed or not. If it is installed, it can be installed in /newsrc or by default in /src. Any existing source code will be safely moved inside a subdirectory of /oldsrc.

It is possible to disable any upgrading whatsoever. If you do this, except the new source code is installed, then you can upgrade to the new system manually as described in development(7). Upgrading to the next release from source is not supported.

FORMAT
The file is read line by line. The # character starts a comment and the rest of the line is ignored. Lines are supposed to contain assignments to variables. An assignment is the name of the variable, whitespace, an equal character, whitespace, the value, whitespace, and then the end of the line.

channel=channel
    If the current release has an upgrade path named channel to a new release, then system upgrades will upgrade to that new release. If no such release path exists or if this variable is not set, upgrades will continue to upgrade to the current release series. Depending on the current release, the offically supported values are stable for stable releases and nightly for development releases. Downgrading releases is not supported. For instance, if the current system is a development release, specifying stable will not downgrade the system to the previous stable release, as no such upgrade path exists. Instead upgrades will upgrade to the next stable release when it becomes available.

force_mirror=[no | yes] (default no)
    Use the preferred mirror set with mirror even if the file specified by release_sig_url does not list it.

grub=[no | yes] (default no)
    States GRUB is used as the bootloader. If either the system or ports are set to yes, then the bootloader is reinstalled ((grub-install) 8) and updated ((update-grub) 8).

mirror=mirror
    Download releases and ports from this preferred mirror, a URL to the top level directory of a mirror. The mirror is only used if the file specified by release_sig_url lists this mirror, unless force_mirror is set to yes. If no mirror is set, a default mirror is used.

newsrc=[no | yes] (default no)
    Place the new source code in /newsrc and move any existing /newsrc into /oldsrc. This preserves the current /src directory. This takes precedence over and disables the behavior described under src.

ports=[no | yes] (default yes)
    Install the new ports. Ports that don't exist anymore will be removed.

release_key=release_key
    Verify the file specified by release_sig_url with the signify(1) public key file at the path release_key. This variable is updated during system upgrades and there is no need to change this variable manually.

release_sig_url=release_sig_url
    Download the meta-information about the current release from the URL release_sig_url. This file is verified with the signify(1) public key in the release_key variable. The file describes the current release, provides checksums of all the published files, lists all the supported mirrors, provides instructions on how to upgrade to this release, and lists all the supported upgrade paths to new releases. This variable is updated during system upgrades and there is no need to change this variable manually.

src=[no | yes] (default no)
    Place the new source code in /src and move any existing /src into /oldsrc.

system=[no | yes] (default yes)
    Install the new system. The upgrade hooks are run if needed as described in following-development(7). This will run update-initrd(8) and if grub is set to no, then regenerate /etc/default/grub.d/10_sortix.cache.

The defaults will be used if /etc/upgrade.conf is missing. If release_key or release_sig_url are absent, tix(8) will not be able to upgrade the current system nor install ports. If channel is absent, tix(8) will not upgrade to new releases.

FILES
/etc/upgrade.conf
    Upgrade configuration.

EXAMPLES

    grub = yes
    ports = yes
    src = no
    system = yes

SEE ALSO
autoinstall.conf(5), autoupgrade.conf(5), upgrade(7), sysupgrade(8), tix(8)