{"id":14063321,"url":"https://github.com/adrianb11/directadmin_rclone_backup","last_synced_at":"2025-07-29T15:32:29.406Z","repository":{"id":41110704,"uuid":"330226050","full_name":"adrianb11/directadmin_rclone_backup","owner":"adrianb11","description":"DirectAdmin RClone Backup is plugin for DirectAdmin to make scheduling backups via cronjob easier.","archived":false,"fork":false,"pushed_at":"2022-06-29T08:44:42.000Z","size":1875,"stargazers_count":12,"open_issues_count":6,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-13T07:04:37.204Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","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/adrianb11.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-16T18:11:30.000Z","updated_at":"2024-08-12T20:09:29.000Z","dependencies_parsed_at":"2022-09-09T05:41:02.476Z","dependency_job_id":null,"html_url":"https://github.com/adrianb11/directadmin_rclone_backup","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianb11%2Fdirectadmin_rclone_backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianb11%2Fdirectadmin_rclone_backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianb11%2Fdirectadmin_rclone_backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianb11%2Fdirectadmin_rclone_backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adrianb11","download_url":"https://codeload.github.com/adrianb11/directadmin_rclone_backup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228028291,"owners_count":17858310,"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","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":[],"created_at":"2024-08-13T07:03:16.284Z","updated_at":"2024-12-04T01:30:35.189Z","avatar_url":"https://github.com/adrianb11.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"# DirectAdmin RClone Backup Interface\n\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/adrianb11/directadmin_rclone_backup)\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)\n[![Scrutinizer code quality (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/quality/g/adrianb11/directadmin_rclone_backup/master?color=teal)](https://scrutinizer-ci.com/g/adrianb11/directadmin_rclone_backup/?branch=master)\n\n## Description\n\nThis is a DirectAdmin plugin that creates Cron Jobs to backup files/databases and uses RClone to upload them to a\nfilehost.\n\n* Files can be compressed into zip, tar, and gzip formats.\n* MySQL, PostgreSQL, and MongoDB databases are supported.\n\nThis was built to make my life easier and because of this, is tailored more to my needs.\n\nBuilt for DirectAdmin 1.61.5 using Evolution skin. I can not guarantee other DA versions or skins will work correctly. I\nhave also only tested this with Dropbox but other hosts should work too. My DA license is only for 1 account, so I\nhaven't tested this on a multi account server.\n\n**Warning** - This plugin adds jobs to the root crontab and runs shell scripts as root. This is so all domains can be\nbacked up from a single account. This also makes backing up databases easier as password does not need to be recorded.\nWhile this is not strictly necessary on a single account license (can be run as admin), files not accessible by admin\ncannot be backed up. If this makes you nervous, please do not install.\n\n### Requirements\n\n* [RClone](https://github.com/rclone/rclone)\n* RClone remotes already created.\n\n### Installation\n\nTo install, simple download the package and install via the package manager in DirectAdmin. During installation, this\nplugin will check if RClone and other packages are installed\n\n### How It Works\n\nThere are 4 main sections to this plugin:-\n\n* **Configuration files**\n    * Each job has its details saved into an .ini file which is used for the actual backup process and to display\n      details on the web interface.\n* **The web interface**\n    * This allows you to create, edit jobs and view any jobs which have been created.\n    * Jobs which have been created are separated into active, inactive, and pending categories.\n    * Each job on the overview tab can be expanded to show its details.\n* **manage_cron script**\n    * This shell script is used to manage any newly created or edited jobs.\n    * On install, a new cronjob is added runs manage_cron.sh on a regular basis.\n    * On each run, this will scan for any newly created or edited jobs and create a new cronjob for them.\n    * The cron created will include a path to the .ini for that job.\n* **backup_job script**\n    * This is responsible for the actual backup of files and execution of RClone.\n    * The backup_job script will use the .ini file passed to create a backup of files and databases requested.\n\n### Usage\n\n* **Once installed, check \"View Settings\" tab to view software installed.**\n    * Software check can be re-run individually or collectively.\n    * manage_cron.sh script can be run from here instead of waiting from scheduled cronjob to run.\n* **Enter default options in \"View/Change Options\" tab.**\n    * Language Selection:-\n        * Language: Any language files created will be displayed in this dropdown box.\n    * Default Compression:-\n        * Compression: Sets the default compression method to use.\n    * File Host:-\n        * File Host Root Path: Sets the root path where files should be uploaded. This will be appended with the full\n          directory path created.\n    * Email:-\n        * Enabled: Sets whether emailed reports should be sent by default.\n        * Default Send Email: This is the email address reports will be sent from.\n    * RClone:-\n        * Available Remotes: List all available remotes you wish to be used. All remotes must be separated by a comma.\n        * Folder Structure: Sets the path to be appended to Root Path. Options are **Case Sensitive!**\n* **Create a new job on the \"Create/Edit Cronjob\" tab.**\n    * Cron Creator:-\n        * Selectable fields to create cronjob times.\n        * Links to select every minute, hour, day, month, and week day.\n    * Cron Preset Templates:-\n        * Clickable preset templates which automatically fill in cron time.\n    * Settings:-\n        * Enabled: Sets whether this job should be enabled (creates ini and cronjob) or disabled (creates ini only).\n        * File Host Root Path: Sets the root path where files should be uploaded. This will be appended with the full\n          directory path created. Field taken from default option saved in options tab.\n        * List of all remotes saved in options tab.\n        * Folder Structure: Sets the path to be appended to Root Path. Options are **Case Sensitive!**. Field taken from\n          default option saved in options tab.\n    * DirectAdmin:-\n        * DirectAdmin Username: A selectable list of all users.\n        * DirectAdmin Domain: A selectable list of all domains. When a username is selected, this field will only show\n          domains assigned to it.\n        * DirectAdmin Sub-Domain:  A selectable list of all sub-domains. When a domain is selected, this field will only\n          show sub-domains assigned to it.\n        * Backup Path: This is automatically generated based on the username, domain, and sub-domain fields. Field can\n          be edited to backup a specific folder.\n        * Exclude Path: Specify the full path to a folder you wish to exclude from the backup.\n        * Database To Backup: A dropdown list of all databases.\n        * Database Type: Select the database type.\n        * Compression: Sets the compression method to use. Field taken from default option saved in options tab.\n    * Email Log:-\n        * Send Email Notifications: Sets whether a notification should be sent when cron is completed.\n        * Email Address: The email address report should be sent to.\n* **View created jobs on \"Cron Overview\" tab.**\n    * Active: Displays all active jobs.\n    * Inactive: Displays all inactive jobs.\n    * Pending: Displays all pending jobs.\n\n### Support\n\nIf you find any issues or have a feature\nrequest, [please create a new issue](https://github.com/adrianb11/directadmin_rclone_backup/issues).\n\n### ScreenShots\n\n#### Overview\n\n![](https://github.com/adrianb11/directadmin_rclone_backup/raw/master/ScreenShots/Overview.png)\n\n#### Create/Edit Cronjob\n\n![](https://github.com/adrianb11/directadmin_rclone_backup/raw/master/ScreenShots/Create.png)\n\n#### View/Change Options\n\n![](https://github.com/adrianb11/directadmin_rclone_backup/raw/master/ScreenShots/Options.png)\n\n#### View Settings\n\n![](https://github.com/adrianb11/directadmin_rclone_backup/raw/master/ScreenShots/Settings.png)\n\n### Acknowledgments\n\n- [Thomas Ba - Cron Expression Generator](https://github.com/thomasba/cron-expression-generator)\n\n### License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrianb11%2Fdirectadmin_rclone_backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadrianb11%2Fdirectadmin_rclone_backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrianb11%2Fdirectadmin_rclone_backup/lists"}