Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Notifications

If you're a Thorium admin looking for instructions on creating/deleting notifications, see Create Notifications.

Notifications are short pieces of information regarding specific entities in Thorium. They are often automatically created when an entity is banned to inform the user of the ban and the reason for it (see Bans), but they can also be manually created by Thorium admins.

Notification Levels

Notifications are assigned a level depending on their severity, similar to log levels in other programs. Below is a table of levels and a description of each one:

LevelDescriptionExpires by default?
InfoThe notification provides some helpful information about the entity that has little or no bearing on its functionYes
WarnThe notification warns users of a possible issue with the entity that may affect its function but doesn't completely disrupt itYes
ErrorThe notification alerts users of a serious issue that impedes the function of the entityNo

When an entity receives a ban, a notification at the Error level is automatically created for the entity. The notification is automatically deleted when the ban is deleted. If an entity has multiple bans, the entity will have multiple notifications, one for each ban.

Notification Expiration

Notifications can automatically "expire" (be deleted) according to the retention settings in the Thorium cluster config (7 days by default). The third column of the above table defines the default expiration behavior of each notification level, specifically that the Info and Warn levels will expire by default while the Error will not. This is because Error notifications are most often associated with bans and should only be deleted once the ban has been removed. Levels' expiration behaviors can be overridden on notification creation (see Creating Notifications - Expiration Behavior for more info).

Viewing Notifications

Thorctl

Image Notifications

You can view notifications for an image with Thorctl with the following command:

thorctl images notifications get <GROUP> <IMAGE>

This will provide a list of the image's notifications color-coded to their level (blue for Info, yellow for Warn, and red for Error).

Pipeline Notifications

You can view notifications for a pipeline with Thorctl with the following command:

thorctl pipelines notifications get <GROUP> <PIPELINE>

This will provide a list of the pipeline's notifications color-coded to their level (blue for Info, yellow for Warn, and red for Error).

Web UI

Notifications are currently not viewable in the Web UI, but this feature is planned for a future release of Thorium!