|
Before you start any backup process, you need to first review your configuration settings!
To access the confiuration area, open the JoomlaCloner component screen, click on the left menu Administration->Configuration
You will notice there 3 main tabs:
- General - this will handle the main backup settings, like paths and backup type
- System - this will handle the internal functioning of the backup process
- Cron - this tab will manage and configure all of the cron process settings
1. Configuration -> General Tab
Backup Path: - this setting will allow you to change the location of where generated backups will be stored on your server, it can be inside or outside your Joomla main path, but it needs to be writeable and accessible by the php user! By default, this path is set to administrator/backups directory
User Packages Path: - this setting is related to the front area of your JoomlaCloner (index.php?option=con_cloner)! If you would like to share with your users custom created clones you need to set this path! This needs to be different than the main backup path, or else you would share by default all your backups! More details on the Front Area of JoomlaCloner section
Manual backup: - this setting will allow you to control on how the backup should get generated, by default it's automatically, or else manually!
What is the manual process?
Manual process was created to help users who have limitations on the time a php script can be executed, for example if you would need to run the backup process for more than 30 seconds, and your host only allows the script to run no more than that limit , the script will end prematurely and get you either a blank screen or a 500 error!
To fix this, if this option is activated(JoomlaCloner Configuration -> Manual Backup option set to Yes), it will allow creation of incremental backups. The administrator will configure how many files should be processed by session so the script will fit the time limit, and when starting the generate process, the JoomlaCloner will refresh the backup adding x number of files at a time!
Note: * this is also an automatic process, you don't need to take any other action, except starting the backup process, but you will need to leave your browser open for refreshing
** the manual backup process doesn't work in cron mode, the cron process will set 'Manual Backup' option to No
Include backup directory in clone: - this option controls wether you want to include the previous created backups in the new generated clone or not! This option only has effect if the backup path is within the Joomla main path
Note: setting this option to Yes, will create backups with incremental size because they will cotain previous generated backups
Archive Type: - this option controls the type of your archive, which can be either TAR or ZIP, depending on your server support for dependencies
Backup using Server Functions:
This option was introduced to give multiple alternatives to users on how the JoomlaCloner should generated a backup
Currently JoomlaCloner can generate backups by either using only php(with the use of pclzip and pcltar libraries), or by using the server utilities zip and tar!
Why so many options?
Each server has some custom settings which limits the user in some way, some servers have memory limitations, which in some cases the user wouldn't be able to generate backups by using the pcl libraries, but if they use the server utilities this problem is fixed.
Options:
Tar path or command: - by default is set to tar, it needs to indicate the full server path to tar utilitity if it's installed on server
Zip path or command: - by default is set to zip, it needs to indicate the full server path to zip utilitiy, if it's installed on server
Mysqldump path or command: - this would needs to indicate the full path to mysqldump utility if it's supported on server
Active checkbox: - this option controls how the backup should get generated, if it's checked the server utilities will be used, saving you more time and memory_problems
- if it's unchecked, the backup will get created by using the internal JoomlaCloner php functions. In some cases you will need to increase your max_execution_time and memory_limit variables from your php.ini
Note: * if you don't support the tar or zip server utilities, you need to uncheck the Active checkbox near them
** if you don't support mysqldump server utiltity, you need to uncheck the Active checkbox near it
Please note each of these server utilities can accept more parameters which can be inputed in the path line, you need to check each one manually for more advanced use:
mysqldump: http://www.linuxcommand.org/man_pages/mysqldump1.html
zip: http://www.linuxcommand.org/man_pages/zip1.html
tar: http://www.linuxcommand.org/man_pages/tar1.html
More related info can be assigned from our FAQ Page
2. Configuration -> System Tab
Folders display: - this option control how to show the directory exclusion list in your Generate Backup screen
- "Javascript Tree mode" will generate you a Javascript tree of all files and directories on site, not recommended for large sites
- "Textarea input box" will show you a input box where you need to input each excluded folder line by line
- "Dynamic selecting" it's the default , and it will show you an AJAX based files and directories list, recommended
Enable Direct Download link: - if this is checked, in the 'View Backups' screen, the download link will be a direct link from your server to download the package, please note that the backup path must be within the Joomla root path for this to have effect! This option was made for users which have memory limitations
Ftp Transfer Mode: - this option control how the ftp process should transfer files when sending files on a remote host, it can either Passive or (the defaut) Active. This option is only for advanced users
FTP Connection Mode: - control how the connection to the ftp server should be, Normal (the default), or Secure. This option is only for advanced users
Files to process per manual session: - this option has effect only if the "Manual Backup" option is set to Yes, it allows you to control how many files should be loaded in a manual session to avoid timeouts
Time between sessions refresh: - this controls the pause time between sesssions refresh, only works if "Manual Backup" option is set to yes
3. Configuration -> Cron Tab
Backup store mode: - this option controls how the cron generated backups will get stored, it has 3 options:
- Local server - the backup will get stored on the local server in the default Backup Path
- Remote ftp account - when done, the generated backups will be transfered to a remote ftp account
- Email - the generated backup will be emailed to an email address
Backup type: - this option controls the type of backup generated from the cron job, it has also 3 options:
- Full(files + database) - will create a full clone of your website, database+files
- Files only - will create only a backup of your Joomla site files
- Database only - will create only a backup of the Joomla site database, which will be stored inside an archive with access path administrator/backups/database-sql.sql
Backup Name: - if this option is set to any name, the generated cron backup will be assigned that name, else a unique name will get generated each time in the format: backup_(date)_(domain)-(sql_mode).(backup_type_zip_or_tar)
Ftp store mode details: - if the backup store mode is set to Remote Ftp Account then you will need to provide the ftp login details as below
Ftp server: - the ftp server address
Ftp username: - ftp server username
Ftp password: - ftp server password
Ftp path: - the ftp location of where the backup will be copied to, needs to exists and be ftp writeable
Delete backup after transfer: - if checked, then the cron backup generated from Ftp store mode will be deleted from the local server, but it will be present on the remote ftp account if all transfer details were right
Email mode details:
Email address: - if the backup store mode is 'Email', you need to provide in this box the email address of where the generated backup will be mailed
Mysql Options
Add Mysql Drop: - this option allows you to add to the generated mysql backup, a DROP TABLE IF EXISTS syntax, only for advanced users
Excluded Directories: - this option allows you to manually exclude directories from the generated cron backup, you need to specify the full path to each file/directory, one per line
|