UniqueSoft/openpanel
2
0
Fork 0
mirror of https://github.com/stefanpejcic/openpanel synced 2025-06-26 18:28:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update backups.md

Browse Source
This commit is contained in:
Stefan Pejcic 2025-04-30 14:05:17 +02:00 committed by GitHub
parent fa3806e5f8
commit 8c62d09c47
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 236 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

238
website/docs/panel/files/backups.md
View File

@ -27,7 +27,7 @@ User can select destination from **Backups > Destinations** page.
Once backup is selected, it's options are available on **Backups > Settings page**.
### SSH
### SSH/SFTP
| Setting | Description |
|----------|----------|
@ -64,13 +64,32 @@ Once backup is selected, it's options are available on **Backups > Settings page
| **WEBDAV_PATH** | The Directory to place the backups to on the WebDAV server. If the path is not present on the server it will be created. Example: `/my/directory/` |
| **WEBDAV_USERNAME** | The username for the WebDAV server Example: `user` |
| **WEBDAV_PASSWORD** | The password for the WebDAV server. Example: `password` |
| **WEBDAV_URL_INSECURE** | Setting this variable to "true" will disable verification of SSL certificates for WEBDAV_URL. You shouldn't use this unless you use self-signed certificates for your remote storage backend. |
### Azure
| Setting | Description |
|----------|----------|
| **AZURE_STORAGE_ACCOUNT_NAME** | The credential's account name when using Azure Blob Storage. This has to be set when using Azure Blob Storage. Example: `account-name` |
| **AZURE_STORAGE_PRIMARY_ACCOUNT_KEY** | The credential's primary account key when using Azure Blob Storage. If this is not given, the command tries to fall back to using a connection string (if given) or a managed identity (if neither is set). |
| **AZURE_STORAGE_CONNECTION_STRING** | A connection string for accessing Azure Blob Storage. If this is not given, the command tries to fall back to using a primary account key (if given) or a managed identity (if neither is set). |
| **AZURE_STORAGE_CONTAINER_NAME** | The container name when using Azure Blob Storage. Example: `container-name` |
| **AZURE_STORAGE_ENDPOINT** | The service endpoint when using Azure Blob Storage. This is a template that can be passed the account name. Example: `https://{{ .AccountName }}.blob.core.windows.net/` |
| **AZURE_STORAGE_ACCESS_TIER** | The access tier when using Azure Blob Storage. Possible values are [listed here](https://github.com/Azure/azure-sdk-for-go/blob/sdk/storage/azblob/v1.3.2/sdk/storage/azblob/internal/generated/zz_constants.go#L14-L30) Example: `Cold` |
### Dropbox
| Setting | Description |
|----------|----------|
| **DROPBOX_REMOTE_PATH** | Absolute remote path in your Dropbox where the backups shall be stored. Note: Use your app's subpath in Dropbox, if it doesn't have global access. Example: `/my/directory` |
| **DROPBOX_APP_KEY** **DROPBOX_APP_SECRET** | App key and app secret from your app created at [https://www.dropbox.com/developers/apps](https://www.dropbox.com/developers/apps) |
| **DROPBOX_CONCURRENCY_LEVEL** | Number of concurrent chunked uploads for Dropbox. Values above 6 usually result in no enhancements. |
| **DROPBOX_REFRESH_TOKEN** | Refresh token to request new short-lived tokens (OAuth2) |
#### Set up Dropbox storage backend
1. Create a new Dropbox App in the [App Console](https://www.dropbox.com/developers/apps)
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):
@ -98,5 +117,220 @@ Once backup is selected, it's options are available on **Backups > Settings page
Important: If you chose `App folder` access during the creation of your Dropbox app in step 1 above, `DROPBOX_REMOTE_PATH` will be a relative path under the App folder! (For example, DROPBOX_REMOTE_PATH=/somedir means the backup file will be uploaded to /Apps/myapp/somedir) On the other hand if you chose Full Dropbox access, the value for `DROPBOX_REMOTE_PATH` will represent an absolute path inside your Dropbox storage area. (Still considering the same example above, the backup file will be uploaded to /somedir in your Dropbox root)
## 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](https://containrrr.dev/shoutrrr/v0.8/services/overview/)
| Service | URL format |
|--------------|------------------------------------------------------------------------------------------------------|
| Bark | `bark://devicekey@host` |
| Discord | `discord://token@id` |
| Email | `smtp://username:password@host:port/?from=fromAddress&to=recipient1[,recipient2,...]` |
| Gotify | `gotify://gotify-host/token` |
| Google Chat | `googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz` |
| IFTTT | `ifttt://key/?events=event1[,event2,...]&value1=value1&value2=value2&value3=value3` |
| Join | `join://shoutrrr:api-key@join/?devices=device1[,device2,...][&icon=icon][&title=title]` |
| Mattermost | `mattermost://[username@]mattermost-host/token[/channel]` |
| Matrix | `matrix://username:password@host:port/[?rooms=!roomID1[,roomAlias2]]` |
| Ntfy | `ntfy://username:password@ntfy.sh/topic` |
| OpsGenie | `opsgenie://host/token?responders=responder1[,responder2]` |
| Pushbullet | `pushbullet://api-token[/device/#channel/email]` |
| Pushover | `pushover://shoutrrr:apiToken@userKey/?devices=device1[,device2,...]` |
| Rocketchat | `rocketchat://[username@]rocketchat-host/token[/channel|@recipient]` |
| Slack | `slack://[botname@]token-a/token-b/token-c` |
| Teams | `teams://group@tenant/altId/groupOwner?host=organization.webhook.office.com` |
| Telegram | `telegram://token@telegram?chats=@channel-1[,chat-id-1,...]` |
| Zulip Chat | `zulip://bot-mail:bot-key@zulip-domain/?stream=name-or-id&topic=name` |
#### 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](https://github.com/Finb/Bark/tree/master/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.
![screenshot 1](https://i.postimg.cc/FmYrJfhZ/sc-1.png)
2. In the left menu, click **Integrations**.
![screenshot 2](https://i.postimg.cc/NtJGM8vF/sc-2.png)
3. On the right, click **Create Webhook**.
![screenshot 3](https://i.postimg.cc/7Djx1x6y/sc-3.png)
4. Set the name, channel, and icon to your preference, then click **Copy Webhook URL**.
![screenshot 4](https://i.postimg.cc/2rvC2PbL/sc-4.png)
5. Press **Save Changes**.
![screenshot 5](https://i.postimg.cc/wqG9GzQL/sc-5.png)
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`.