{"id":18063395,"url":"https://github.com/eugenefvdm/backup-notifier","last_synced_at":"2025-08-01T13:34:32.230Z","repository":{"id":147672224,"uuid":"397802193","full_name":"eugenefvdm/backup-notifier","owner":"eugenefvdm","description":"A shell script that can be used with Virtualmin for pre- and post backup commands.","archived":false,"fork":false,"pushed_at":"2021-09-01T04:04:37.000Z","size":111,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T13:27:20.044Z","etag":null,"topics":["backup","shell","virtualmin"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eugenefvdm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-08-19T03:17:50.000Z","updated_at":"2021-12-15T09:34:08.000Z","dependencies_parsed_at":"2023-06-27T14:24:06.991Z","dependency_job_id":null,"html_url":"https://github.com/eugenefvdm/backup-notifier","commit_stats":null,"previous_names":["eugenefvdm/backup-notifier"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/eugenefvdm/backup-notifier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugenefvdm%2Fbackup-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugenefvdm%2Fbackup-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugenefvdm%2Fbackup-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugenefvdm%2Fbackup-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eugenefvdm","download_url":"https://codeload.github.com/eugenefvdm/backup-notifier/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugenefvdm%2Fbackup-notifier/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268231437,"owners_count":24217033,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","shell","virtualmin"],"created_at":"2024-10-31T05:11:00.102Z","updated_at":"2025-08-01T13:34:32.203Z","avatar_url":"https://github.com/eugenefvdm.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Virtualmin Slack Backup Notification\n\n## Description\n\nA Slack Hook notifier designed to work as pre- and post-backup command notifiers for Virtualmin backups\n\n## Installation Instructions\n\n- The only files in this repo needed are `run.sh` an `.env` file which can be copied from `.env.example`\n- Copy `run.sh` to any directory, e.g. `/root/backup-notifier`\n- Copy `.env.example` to the same directory and rename it `.env`\n- Create a new Slack Hook\n- Store the Slack Hook URL in an `.env` file\n** Double check your credentials **\n- Use the Virtualmin UI to populate the the pre- and post-backup commands\n\n### Create a Slack App and get the hook URL\n\nA Slack App is the basic neccesity one needs before being able to use a Slack Hook.\u003cbr\u003e\nThe free plan of Slack comes with 10 Slack Apps.\n\nFollow the Slack instructions here to create a new App:\u003cbr\u003e\nhttps://slack.com/intl/en-za/help/articles/115005265063-Incoming-webhooks-for-Slack\n\n### Create a .env file with your newly created Slack hook\n\nCopy .env.example to .env\n\n```Shell\n`SLACK_HOOK=your_slack_hook_here`\n`POST_TO_SLACK=true`\n```\n\nThe other value in the `.env` is:\n\n`APP_DEBUG=false`\n\nIf this is changed to `true` and then various progress messages will be logged during the script's execution.\n\n## Usage\n\n### Populate Virtualmin pre- and post-backup commands\n\nLook at Example Use below if you just want to get going.\n\n#### Parameters Used\n\nThe script reads these two variables which are push to the Shell by Virtualmin:\n- `$BACKUP_STATUS`\n- `$BACKUP_DEST`\n\nBy reading those variables the script can determine if backup was successful, and what the destination was.\u003cbr\u003e\nThe script furthermore will deduce the backup has started and not finished if `$BACKUP_STATUS` is absent.\n\n### Example Use\n\nThe pre- and post-backup command syntax is exactly the same. See the Virtualmin UI Screenshot below to see where these commands are added.\n\nThe purpose of the pre-backup command is to set a start marker which is used by the post-backup command to calculate how long the backup took.\n\nPre-backup command:\n```bash\n/bin/bash /root/backup-notifier/run.sh\n```\n\nPost-backup command:\n```bash\n/bin/bash /root/backup-notifier/run.sh\n```\n\n## Screenshots\n\n### Virtualmin UI\n\n![Alt text](docs/images/virtualmin_ui_screenshot.png?raw=true \"Virtualmin UI / Pre- and Post-Backup Commands\")\n\n### Slack UI\n\n![Alt text](docs/images/virtualmin_slack_notification_screenshot.png?raw=true \"Slack Notifications\")\n\n## License\n\nMIT\n\nThis sofware is open-sourced software licensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feugenefvdm%2Fbackup-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feugenefvdm%2Fbackup-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feugenefvdm%2Fbackup-notifier/lists"}