💾 Cloudflare Worker Duplicati Discord Notifications

This Cloudflare worker provides an endpoint for Duplicati backups that proxies notifications to a Discord channel using a webhook. With this worker, you can ensure that you receive notifications for all of your backup events. If you'd like to host your own worker, follow the instructions below.

Note is ./assets/example_data.json you can see what data Duplicati sends if you ever wish to tweaks the script

A- Create the Webhook URL

1- Start by creating a Discord webhook in the channel where you want to receive notifications. If you're not sure how to do this, Discord's support page provides a detailed guide on how to create a webhook.

2- Once you've created the webhook, copy the URL and keep only the part after https://discord.com/api/webhooks/.

For example, if your webhook URL is:

https://discord.com/api/webhooks/123456789012345678/abcdefgHIJKLMNOPQRStuvwxyz0123456789`

You should keep only:

123456789012345678/abcdefgHIJKLMNOPQRStuvwxyz0123456789

This part of the URL represents the channelId/webhookId.

3- Add a name to identify your backup MyBackUpName/channelId/webhookId. This name will be displayed in the webhook embed.

4- Append MyBackUpName/channelId/webhookId to https://duplicati.faceslog.tech/api/.

The URL should look like this:

https://duplicati.example.org/api/MyBackup/123456789012345678/abcdefgHIJKLMNOPQRStuvwxyz0123456789

B- Add it to duplicati

To add the notification URL to Duplicati, follow these steps:

1- Go to the Duplicati WebUI and select the backup you want to receive notifications for.

2- Click on the "Edit" button to edit the backup configuration.

3- In the "Options" section, click on the three dots next to "Advanced options" and select "Edit as text".

4- Add the following lines to the configuration:

--send-http-verb=POST
--send-http-url=https://duplicati.example.org/api/MyBackup/123456789012345678/abcdefgHIJKLMNOPQRStuvwxyz0123456789
--send-http-result-output-format=Json

Note that --send-http-url should be the URL you created in the previous step.

5- Save the configuration file and you're all set!

Your backup should now send a notification to the Discord channel you set up whenever it runs. If you want to receive notifications for multiple backups, you can repeat the steps for each backup and create a unique URL for each one.

Deploy your own worker

If you'd like to host your own webhook endpoint instead of using the example one, you can follow these steps:

1. Clone this repository:

   git clone https://github.com/faceslog/cf-worker-duplicati.git
   cd cf-worker-duplicati
   

2. Install the required dependencies:

   npm install
   

3. Edit the wrangler.toml file:

   • Replace the pattern value duplicati.example.org with your own domain name.

   For more detailed instructions on how to configure your Cloudflare worker, please see the official documentation.

4. Log in to your Cloudflare account using Wrangler:

   npx wrangler login
   
   # On a remote machine check: https://developers.cloudflare.com/workers/wrangler/commands/#use-wrangler-login-on-a-remote-machine

5. Once you've configured your worker, you can deploy it by running:

   npm run deploy
   

6. After your worker is deployed, you can use the URL it provides to set up notifications in Duplicati, as described in the previous section of this README. Make sure to use the same domain as the one in your wrangler.toml.

Development

To run the worker locally for development:

npm run dev

This will start a local server that simulates the Cloudflare Workers environment, allowing you to test your changes before deployment.

Troubleshooting

If you encounter any issues during deployment:

1. Ensure that you're logged in to the correct Cloudflare account.
2. Check that your wrangler.toml file is correctly configured.
3. Verify that you have the necessary permissions to deploy Workers in your Cloudflare account.
4. If you're using environment variables for sensitive information, make sure they're properly set.

Cloudflare WAF and Server IP Considerations:

When deploying or sending requests to your worker from a server, you may encounter issues with Cloudflare's Web Application Firewall (WAF). The WAF might block requests originating from server IP addresses as a security measure. To ensure smooth operation, consider creating a WAF bypass rule for your worker's specific path.

Others

Don't hesitate to message me for any problem with it, feel free to make a pull request to improve it !

Another project that does the same thing using Google Cloud Platform: https://github.com/jameslloyd/duplicati-discord-notification (I try to avoid google services 😅)