Server Backup: Restore Points for Kage and Discord

The server backup creates restore points: a snapshot of your Kage settings and, if you want, of the Discord base structure made of categories, channels and roles. From a restore point you can later bring settings back or have missing channels and roles created again.

For a short walkthrough, see the guide Backing up your server.

What a backup contains and what it does not

For the structure, Kage saves:

• Roles: name, colour, separate display, mentionability, permissions and position. Roles managed by an integration or a bot, and @everyone, are left out.
• Categories: name, position and the permissions for roles.
• Channels: name, type (text or voice), category, position and the permissions for roles. Text channels also keep their topic.

Not saved are messages, members and their role assignments, permissions of individual members, emojis, stickers, threads and webhooks. Data such as XP totals, economy balances or warnings is not included either: for the configuration, Kage only saves the modules' settings.

Requirements

• Access to the module: You sign in to the dashboard with Discord and need the Manage Server permission (or access granted for this module).
• For commands: You need the Administrator permission.
• Kage's permissions: to save the structure, Kage must be able to see the channels and roles. To restore, Kage needs Manage Channels and Manage Roles.
• Plan: The plan notice at the top of this page shows which plan the module needs.

Creating a backup

In the dashboard: Open Server Backup, choose the Type, optionally enter a Label and click Create backup.

By command: /backup create type:<type> label:<label>. Without a type, Kage saves configuration and structure.

The list of restore points shows type, label, contents (number of modules, roles, categories and channels) and creation time. Kage creates no automatic backups, you trigger each one yourself.

Limit

Kage keeps only a limited number of restore points. Once the limit is reached, the next backup deletes the oldest point.

For backups you create by command, Kage trims to the newest 20 regardless of plan. If you create many points by command, that can delete older points your plan would otherwise keep.

Restoring

In the dashboard: Click Restore on a point and confirm.

By command: /backup list shows the latest points with their number. /backup restore id:<number> asks with a button. Only the person who entered the command can confirm, and the prompt expires after two minutes.

Configuration

Kage writes back the saved settings of every module contained in the backup, including whether it was on or off. The current settings of those modules are overwritten. Modules that are not in the backup stay unchanged. Kage skips modules that no longer exist.

Note: settings refer to channels and roles by their ID. If the restore recreates a deleted channel, it gets a new ID. A setting that points to the old channel then points nowhere until you choose the channel again in the module. The dashboard and the monitoring point out such gaps.

Structure

Restoring the structure is purely additive:

• Kage only creates what is missing. The comparison runs by name. If a role, category or channel with that name already exists, Kage leaves it unchanged. For channels, any channel with the same name counts, regardless of its category.
• Nothing is deleted or overwritten.
• Newly created roles, categories and channels get their saved position and the permissions for roles back. Roles are matched by name as well.
• Kage restores the order of roles on a best-effort basis. Discord does not allow positions at or above Kage's highest role, in which case the role stays where Discord places it.
• If Discord cannot create something, for example a role with permissions Kage does not have itself, Kage skips it and continues with the rest.
• Channels that were saved by command and were stage or forum channels are recreated by Kage as text channels.

After the restore, Kage shows how many modules were restored and how many roles, categories and channels were created, or that there was nothing to do.

Deleting a restore point

Delete removes a point permanently. This cannot be undone. Your current configuration and your Discord server stay unchanged.

Settings at a glance

The module has no settings of its own. It consists of the list of restore points and the commands:

Kage logs commands in the Logs tab, as well as deleting in the dashboard.

Checking the result

1. Back up: Create a backup of type "Config + structure". It appears in the list with the number of modules, roles, categories and channels.
2. Test channel: In Discord, create a test channel, back up again, delete the channel and restore the new point.
3. Result: The channel is back, all other channels are unchanged.

Troubleshooting

"Discord structure could not be read"

Kage cannot read your server's channels or roles right now. Try again. If it persists, check Kage's permissions.

After restoring, a module points to a missing channel

The channel was recreated and has a new ID. Choose it again in the module.

A role or channel was not recreated

If something with the same name already existed, Kage leaves it unchanged. Otherwise Kage lacks permissions, or Discord rejected the role because it contains permissions Kage does not have itself.

The role sits in a different place

Discord only allows positions below Kage's highest role. Move the role by hand.

The restore button does not respond

The prompt only applies to the person who entered /backup restore, and only for two minutes. Enter the command again.

An older point disappeared

The limit was reached and the oldest point was deleted, see "Limit".

Further reading

Report problems automatically: Monitoring.