Backups

In OpenPanel, backups are configurable directly by the panel users, unlike other panels where backups are managed by the admin.

This empowers users to define their own backup schedules, choose exactly what to back up, and select from a wide range of supported destinations. As a result, administrators have fewer tasks to manage, and users gain greater control and flexibility.

Destinations​

OpenPanel supports the following destinations:

• S3 storage - AWS S3, Filebase, MinIO, etc.
• WebDAV - Remote backups using WebDAV.
• SSH - Remote backups via SSH to another server.
• Azure - Remote backups to Azure Blob Storage.
• Dropbox - Remote backups to Dropbox cloud storage.

User can select destination from Backups > Destinations page.

Once backup is selected, it's options are available on Backups > Settings page.

SSH/SFTP​

S3​

WebDAV​

Azure​

Dropbox​

Set up Dropbox storage backend:

1. Create a new Dropbox App in the App Console
2. Open your new Dropbox App and copy the DROPBOX_APP_KEY and DROPBOX_APP_SECRET
3. Click on Permissions in your app and make sure, that the following permissions are cranted (or more):
   • files.metadata.write
   • files.metadata.read
   • files.content.write
   • files.content.read
4. Replace APPKEY in https://www.dropbox.com/oauth2/authorize?client_id=APPKEY&token_access_type=offline&response_type=code with the app key from step 2
5. Visit the URL and confirm the access of your app. This gives you an auth code -> save it somewhere!
6. Replace AUTHCODE, APPKEY, APPSECRET accordingly and perform the request from your terminal:

   curl https://api.dropbox.com/oauth2/token \
   -d code=AUTHCODE \
   -d grant_type=authorization_code \
   -d client_id=APPKEY \
   -d client_secret=APPSECRET
   
7. Execute the request. You will get a JSON formatted reply. Use the value of the refresh_token for the last setting DROPBOX_REFRESH_TOKEN
8. You should now have DROPBOX_APP_KEY, DROPBOX_APP_SECRET and DROPBOX_REFRESH_TOKEN set. These don’t expire.

Encryption​

Bakcup encryption is by default disbaled and needs to be enabled by the Administrator first.

All of the encryption options are mutually exclusive. Provide a single option for the encryption scheme of your choice.

Rotation​

Source​

By default, everything will be backed up. In case you need to backup only a specific data, set BACKUP_SOURCES.

Available options are:

Schedule​

Backups can be run on fixed scheduled that are defined as a cron expression. BACKUP_CRON_EXPRESSION is used to schedule the backup job, a cron expression represents a set of times, using 5 or 6 space-separated fields.

Month and Day-of-week field values are case insensitive. "SUN", "Sun", and "sun" are equally accepted. Refer to sites like crontab.guru for help.

If no value is set, @daily will be used, which runs every day at midnight.

Compression​

Names​

Options here are available byt disabled by defuatl and need to be manually enabled by the Administrator first.

Exclude​

BACKUP_EXCLUDE_REGEXP - When a value is given, all files in BACKUP_SOURCES whose full path matches the regular expression will be excluded from the archive. Regular Expressions can be used as from the Go standard library. Example: \.log$.

Notifications​

Notifications (email, Slack, etc.) can be sent out when a backup run finishes.

NOTIFICATION_URLS​

Configuration is provided as a comma-separated list of URLs as consumed by shoutrrr

Email​

URL Format:

smtp://username:password@host:port/?from=fromAddress&to=recipient1[,recipient2,...]

URL Fields:

• Username – SMTP server username
  Default: empty
  URL part: smtp://username:password@host:port/

• Password – SMTP server password or hash (for OAuth2)
  Default: empty
  URL part: smtp://username:password@host:port/

• Host – SMTP server hostname or IP address (Required)
  URL part: smtp://username:password@host:port/

• Port – SMTP server port
  Common values: 25, 465, 587, 2525
  Default: 25
  URL part: smtp://username:password@host:port/

Query/Param Props:

Props can be supplied via the params argument or directly in the URL using ?key=value&key=value.

• FromAddress – Email address the mail is sent from (Required)
  Aliases: from

• ToAddresses – Comma-separated list of recipient emails (Required)
  Aliases: to

• Auth – SMTP authentication method
  Default: Unknown
  Possible values: None, Plain, CRAMMD5, Unknown, OAuth2

• ClientHost – Hostname sent to the SMTP server during the HELO phase
  Default: localhost
  Set to "auto" to use OS hostname

• Encryption – Encryption method
  Default: Auto
  Possible values: None, ExplicitTLS, ImplicitTLS, Auto

• FromName – Name of the sender
  Default: empty

• Subject – Subject line of the email
  Default: Shoutrrr Notification
  Aliases: title

• UseHTML – Whether the message is in HTML format
  Default: ❌ No

• UseStartTLS – Whether to use StartTLS encryption
  Default: ✔ Yes
  Aliases: starttls

Bark​

URL Fields:

• DeviceKey – The key for each device (Required)
  URL part: bark://:devicekey@host/path

• Host – Server hostname and port (Required)
  URL part: bark://:devicekey@host/path

• Path – Server path
  Default: /
  URL part: bark://:devicekey@host/path

Query/Param Props:

Props can be either supplied using the params argument, or through the URL using ?key=value&key=value etc.

• Badge – The number displayed next to App icon
  Default: 0

• Category – Reserved field, no use yet
  Default: empty

• Copy – The value to be copied
  Default: empty

• Group – The group of the notification
  Default: empty

• Icon – A URL to the icon, available only on iOS 15 or later
  Default: empty

• Scheme – Server protocol, http or https
  Default: https

• Sound – Value from Bark Sounds
  Default: empty

• Title – Notification title, optionally set by the sender
  Default: empty

• URL – URL that will open when notification is clicked
  Default: empty

Discord​

URL Format:

discord://token@webhookid

URL Fields:

• Token – (Required)
  URL part: discord://token@webhookid/

• WebhookID – (Required)
  URL part: discord://token@webhookid/

Query/Param Props:

Props can be either supplied using the params argument, or through the URL using ?key=value&key=value etc.

• Avatar – Override the webhook default avatar with specified URL
  Default: empty
  Aliases: avatarurl

• Color – The color of the left border for plain messages
  Default: 0x50D9ff

• ColorDebug – The color of the left border for debug messages
  Default: 0x7b00ab

• ColorError – The color of the left border for error messages
  Default: 0xd60510

• ColorInfo – The color of the left border for info messages
  Default: 0x2488ff

• ColorWarn – The color of the left border for warning messages
  Default: 0xffc441

• JSON – Whether to send the whole message as the JSON payload instead of using it as the content field
  Default: ❌ No

• SplitLines – Whether to send each line as a separate embedded item
  Default: ✔ Yes

• Title
  Default: empty

• Username – Override the webhook default username
  Default: empty

Creating a Webhook in Discord:

1. Open your channel settings by clicking the gear icon next to the channel name.
2. In the left menu, click Integrations.
   
3. On the right, click Create Webhook.
   
4. Set the name, channel, and icon to your preference, then click Copy Webhook URL.
   
5. Press Save Changes. 6 Format the service URL:

   https://discord.com/api/webhooks/693853386302554172/W3dE2OZz4C13_4z_uHfDOoC7BqTW288s-z1ykqI0iJnY_HjRqMGO8Sc7YDqvf_KVKjhJ
                                    └────────────────┘ └──────────────────────────────────────────────────────────────────┘
                                        webhook id                                    token
   
   discord://W3dE2OZz4C13_4z_uHfDOoC7BqTW288s-z1ykqI0iJnY_HjRqMGO8Sc7YDqvf_KVKjhJ@693853386302554172
             └──────────────────────────────────────────────────────────────────┘ └────────────────┘
                                             token                                    webhook id
   

NOTIFICATION_LEVEL​

By default, notifications would only be sent out when a backup run fails. To receive notifications for every run, set NOTIFICATION_LEVEL to info instead of the default error.