Skip to main content

Backup scheduler

Imagine regularly creating backups of your server without having to remember to do it manually. That's where the scheduler comes in!

You can set an automated recurring backup for your server, and the bot will perform the backup on its own, and send you the backup code in a DM message once it's done.

Premium Feature

This feature requires an active Premium license to work.

View schedules

You can view the currently set schedules with the mb!scheduler command.

Set up a schedule

To create a schedule, you first need to be an ADMIN of the server. You can set up a new recurring schedule with the following command:

mb!scheduler set recurring <?h?m>

the interval is passed in the format of e.g. 3h30m for a backup every 3 hours and 30 minutes.

Remove a schedule

To remove a schedule, you can use:

mb!scheduler clear recurring [all]

Omitting all argument (mb!scheduler clear recurring) will only clear the schedules you created, while including all will clear all schedules for the server, including those created by other admins.

The use of all requires being the server OWNER.

Recipients of the backup code

The backup code will be sent to the user who created the schedule that has finished running the backup.

You can however alter the recipient list by using mb!scheduler recipients command.

View the current recipient list with:

mb!scheduler recipients list

Add a user to the recipient list with:

mb!scheduler recipients add <user-id>

Remove a user from the recipient list with:

mb!scheduler recipients remove <user-id>

Customize backup options

By default, the scheduled backups runs the exact same logic as the mb!create command without any options provided.

You can customize the options with mb!scheduler setOptions command.

mb!scheduler setOptions <options string ...>

The options string is the same as the options you would provide to mb!create command, e.g.:

mb!scheduler setOptions
-saveAttachments
-msgLimit 500
-excludeChannel memes

Log channel configuration

By default, the bot will post a progress message both in the creator DMs, and the channel where the schedule was created.

You can change the log channel options with mb!scheduler setLogChannelOptions command:

mb!scheduler setLogChannelOptions [send <on|off>] [edit <on|off>]

By default, both send and edit are set to on, which means the bot will send a new message when the backup starts, and edit that message with progress updates as the backup is being created.

Some users have requested to add a way to disable any message edits, since the event triggered other logging bots in their server.

To disable message edits, set edit to off:

mb!scheduler setLogChannelOptions edit off

Disabling the send option will prevent the bot from sending any messages in the log channel, and it will only send a message if the backup fails.