Skip to content
SoKnight Plugins

Channels and pinning

Channels

Section titled “Channels”
Channel Gets Good for
stable Releases that spent at least a week on beta Production servers
beta Release candidates, usually a few per month A staging server, small networks
preview Every build that passes tests Testing new features, plugins below 1.0

default-channel applies to every plugin; override it per plugin:

default-channel: stable
plugins:
  PunishSync:
    channel: preview      # PunishSync only ships on preview until 1.0

Plugins in preview, like PunishSync, have no stable builds. ForgeRelay falls back to the nearest channel that has one and logs which one it used.

Pinning

Section titled “Pinning”

A pin holds a plugin on one version, whatever its channel says:

plugins:
  StreamGate:
    pin: 1.6.1

Or from the console: /forgerelay pin StreamGate 1.6.1, and /forgerelay unpin StreamGate to undo. Pins are useful before a big event, or while you wait for a fix.

Per-server channels

Section titled “Per-server channels”

Since 1.3.0, each server picks its own channels. A network can run preview on a test server and stable everywhere else from the same config template by overriding default-channel with the FORGERELAY_CHANNEL environment variable.