Code Monkey home page Code Monkey logo

backupmodx's Introduction

Default Lexicon

BackupMODX

Backup Dashboard Widget for MODX CMS.

Features

The BackupMODX extra is a tiny dashboard widget. Just place the widget into your dashboard and click the "Backup" button whenever you need a quick backup of your site. You can select either to backup your database, files or both. After the backup is finished you can download the files as a zip-archive. Just click the "Remove Backup" button after your download is finished to remove the backup.

The extra will backup all files and folders inside your MODX installation and will also include the core-folder if placed outside the web-root.

The widget is tested in different hosting environments and it works for our needs. If you have any problems/errors while using this extra - please let us know. If you also know how to enhance the extra/code - please feel free to contribute to the GitHub Repository.

Installation

MODX Package Management

Usage

Install via package manager and add the BackupMODX widget to the dashboard.

System Settings

Setting Description Default
backupmodx.cronDatabase Whether or not to include the database in cron-backup. Yes
backupmodx.cronEnable Enable cron backup. No
backupmodx.cronFiles Whether or not to include MODX files in cron-backup. Yes
backupmodx.cronKey Security key for cron scheduled backups. Can be any string.
backupmodx.cronMaxDatabase Maximum stored backups of the database. 5
backupmodx.cronMaxFiles Maximum stored backups of files. 5
backupmodx.cronNote Optional description txt file added to the backup.
backupmodx.excludeFiles Files to be excluded from the backup. Comma separated list. Regular expressions are possible. Example: \..* for file names, that start with a dot.
backupmodx.excludeFolders Folders to be excluded from the backup. Comma separated list. Path placeholder ({assets_path}, {base_path}, {core_path}) are available. Example: {assets_path}uploads/
backupmodx.groups Comma separated list of groups names, that will have access to the widget. Administrator
backupmodx.targetPath The path to the folder to store the backups. Path placeholder ({assets_path}, {base_path}, {core_path}) are available. Example: {core_path}backup/ {core_path}backup/
backupmodx.timelimit Timelimit for the backup in seconds. 120

Cron job

Setup a cronJob for the Script located in assets/components/backupmodx/cron.php and append your cronkey as a key parameter. If your provider does not support cronjobs you can also use an online service like cron-job.org. The web cronjob looks like: https://yourdomain.com/assets/components/backupmodx/cron.php?key=xyz123456789

License

The project is licensed under the GPLv2 license.

Translations

Translations of the package can be made for the Default Lexicon and the System Setting Lexicon

backupmodx's People

Contributors

dependabot[bot] avatar jako avatar jdaehne avatar jenswittmann avatar mark-h avatar mcnickel avatar weblate avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.