joomlapack manual
LINK 1 ENTER SITE >>> Download PDF
LINK 2 ENTER SITE >>> Download PDF
File Name:joomlapack manual.pdf
Size: 3371 KB
Type: PDF, ePub, eBook
Category: Book
Uploaded: 2 May 2019, 19:54 PM
Rating: 4.6/5 from 717 votes.
Status: AVAILABLE
Last checked: 1 Minutes ago!
In order to read or download joomlapack manual ebook, you need to create a FREE account.
eBook includes PDF, ePub and Kindle version
✔ Register a free 1 month Trial Account.
✔ Download as many books as you like (Personal use)
✔ Cancel the membership at any time if not satisfied.
✔ Join Over 80000 Happy Readers
joomlapack manualWho made this? Before using Kickstart Getting Kickstart Requirements Using Kickstart Procedure overview.62 Page 3 JoomlaPack is a multi-purpose backup and cloning component for the awarded Open Source CMS Joomla!. In a simple and transparent operation it will grab a copy of your site's files and a snapshot of your site's database and package them in a compressed archive file with a restoration script. The restoration script follows the spirit of the familiar Joomla.It even comes with a wizard (JoomlaPack Kickstart) which makes unpacking the archive and restoring your site a piece of cake. JoomlaPack is more than a backup tool; it is a site cloner. This means that the resulting backup can be restored on any server, not only on the one it was taken from. This lets you very easily grab a copy of your live site, running on a Linux host, and restore it on your local test server, running on Windows. Or even vice versa. The possibilities for using this component are just too many. Some indicative uses might be: Security backups. Taking a snapshot of your site should your server fail, or a hacker exploit some security hole to deface or compromise your site. Template sites. Web professionals have used JoomlaPack in order to create template sites. This means that you can build a site on a local server, install every component you usually do on most clients' sites and back it up. You now have a canned site that can serve as a great template for future clients. Using the same method you can have a snapshot of all the sites you have built for your clients, without the need to have them installed on your local server. Build a site off-line, upload the finished site easily. Web professionals can build a complete site off-line on a local server and when done take a snapshot with JoomlaPack, then restore it on the production site. Testing upgrades locally, without risking breaking the on-line site. Joomla!http://imajtransport.com/userfiles/juki-ms-1261-manual.xml
- Tags:
- joomlapack manual.
updates have the potential of breaking things, especially in complex or badly written components and modules. Web masters use JoomlaPack to get a site snapshot, restore it on a local test server, perform the upgrade there and test for any problems without the live site being at risk. Debugging locally. Almost the same as above, web professionals have used JoomlaPack to take a snapshot of a client's Joomla.Using JoomlaPack again, they can upload the fixed site back on the live server. Relocating a site to a new host. Web masters who want to take their site to a new host have found JoomlaPack to be their saviour. Just backup the original site and restore on the new host; presto, your site is relocated with virtually no effort at all. JoomlaPack can save you hours of your time. This is what hundreds of our users tell us. Moreover, this invaluable tool comes to you at no cost. JoomlaPack is licensed under the GNU General Public License Version 2 or any later version. Page 6 There are other backup components for Joomla!, both free and commercial. There is also the possibility to write cron scripts yourself using standard utilities such as tar and mysqldump. We felt that these utilities did not do what we wanted, the way we wanted or were overpriced or took a lot of time to use. JoomlaPack is our personal view on usability and efficiency. It seems, though, that thousands of web masters agree with our perspective and this gives us the incentive to keep on coding. Requirements In order to work, JoomlaPack requires the following software environment on your server: Joomla.The PHP function 'opendir' or 'glob' to be available ('opendir' recommended). Available free space or quota limit about 75-80 of your site's size. The PHP safe mode should be preferably turned off (after all it offers no real security), but JoomlaPack will still work with it enabled. This component may work with other AJAX-capable browsers, but it has not been tested against them. 1.http://jagtapnursery.com/jagtap-nursery/upload/juki-pm-1-software-manual.xml2 Overview The way JoomlaPack works is of great importance in the event of troubleshooting. Therefore, this is a small presentation of the inner workings of JoomlaPack. You should read this section even if you are familiar with JoomlaPack; the work flow has changed in version Each backup procedure consists of three individual operations (or domains in JoomlaPack jargon), occurring one after the other. Each operation is performed in several steps. The operations are: Initialization. When you start the backup, JoomlaPack has to do some housekeeping. It will create the (now empty) archive file, load filter settings and clean-up after any previous failed backup attempts. After that, the archive will be loaded with the files which make up the selected installer. The inclusion of the installer files happens without using temporary files, for security reasons (a vast improvement since version 1.2) This all happens transparently, without you ever noticing it. Note: the extraction of the installer files happens in a separate operation which may run in multiple steps on slow servers, but its progress is not reported as an individual operation in the backup progress page. Page 7 Each step consists of dumping a preset, user-definable, amount of data of a single table. The SQL files are added to the archive at the end of the operation and the temporary files are disposed of immediately. Archive creation (packing). Upon finishing scanning a directory, it will add the files to the archive. The rest of the data, if any, will be archived on the next step. Finalization. Finally, JoomlaPack performs some housekeeping, removing the temporary files and temporary database entries. This operation is logged as a special domain named 'finale'. 1.3 Documentation Conventions This documentation uses some typographic conventions to convey important information. The first thing you should be aware of are the Important notes paragraphs. They look like this: Important.https://www.thebiketube.com/acros-boss-dd20-manuale-italiano This is a sample of an Important notes paragraph. These are used throughout the documentation to denote some piece of information which is not obvious but you should be aware of. These paragraphs point out some non-obvious information you must be aware of. Reading these thoroughly will decrease the chance of getting stuck and will alleviate the need to post to the support forums for help. Then, there are code sections, which look like this: This is a code section. Please note how this very long line wraps. As you can see the wrapped portion does not start exactly at the start of the line, but leaves a small space in the beggining. This is a normal line which doesn't wrap. And this is yet another line of code. Code sections are used mainly for external configuration file contents. Page 8 The one ending in -j10 is the version compatible with Joomla! 1.0.x (and Joomla! 1.5.x with the Legacy Plugin enabled). The other one, ending in -j15 is the Joomla! 1.5.x Native Mode compatible version. Please download and install the proper version of the component. Failure to do so will result in installation errors and you'll have to eventually use the correct version Development snapshots For the adventurous among you, there is the option to download the latest development version via SVN. The development code is located at Important. SVN code is not meant to be secure, stable or thoroughly tested; it is just a snapshot of the development progress. You use it at your own risk. Support is minimal but we welcome all your comments and bug reports which help us make JoomlaPack a better component. First of all, make sure you've got Subversion installed. You can get the latest snapshot by creating a new directory and issuing the command: svn checkout This results in a set of directories, containing the latest development files. In order to create an Joomla!-installable ZIP archive you have to go into the 'scripts' directory and use the makejp.php script. The makejp.http://creaturegraphics.com/images/10b-manual.pdfphp script is supposed to be run from the command line, not from a web server. If you try accessing the script from a web server you'll get an explanatory text. In order to create an installable ZIP, you have to go into the 'scripts' directory and issue the command: php makejp.php --makezip --makejpi If the PHP executable is not in your path, you'll have to accommodate for that in the aforementioned instructions by supplying the full path to the PHP executable. Make sure the 'release' folder and its contents are writeable.After you have downloaded the component, log in as a Super Administrator in your website. From the top menu bar choose Installer, Components. Click browse and locate the archive you have already downloaded. The component is available only to the Super Administrator group. This is a security measure, since the generated backup files contain everything in your site. For more information on security concerns and advice, please take a look at the ''Security concerns'' chapter in this document. Make sure you have deinstalled any previous versions of the component prior to installing the new version. Joomla! does not offer a component upgrade path and will complain if you try to install the new version over the old one. 2.3 Upgrading the component As mentioned above, Joomla.In order to upgrade one has to deinstall the previous version and install the new one. This has one major shortcoming: the configuration is lost in the process as the configuration XML file gets deleted and the database tables dropped. In order to counter this significant shortcoming, we came up with the Configuration Migration feature of JoomlaPack. Using this feature you can take a backup of your entire configuration set (configuration options and all of the filters' settings) into an XML file, stored on your local computer. When you're done upgrading, you can use the same feature to upload the configuration backup file and regain all of your previous settings. Page 10 While the essence of the component's functions is the same, there will be some minor layout differences in the Joomla! 1.0.x version. Important! There is one known problem with Joomla! 1.0.x installations. When you click the Save button from the Options page, Joomla.This is annoying, but the cause of this problem has not been positively detected. We are not willing to spend time over this, because Joomla! 1.0.x is an end-of-life product. We expect that the user base will migrate to Joomla! 1.5.x and we will eventually drop support for Joomla! 1.0.x. 3.1 Common Elements All pages have their title displayed above their contents. On the far right of the title there is a home button. Clicking on this will get you back to the JoomlaPack Control Panel. On the bottom of each page, just above the Joomla.From here you can see if everything is in working order and access all of the component's functions and configuration options. Page 11 The first, named Overview, will show if your configuration is in working order (green text) or there are errors (red text). It will also warn you if you are using the default backup directory, as this may pose a security threat. The tab named Details gives you the specifics of each configuration value monitored. There are currently two locations being monitored, both need to be writeable for the application to work correctly: Temporary Folder is where JoomlaPack stores temporary files while it is packing your site. This will also contain a snapshot of your database if the database dump process dies with a PHP fatal error, so make sure the directory is not world-readable. Output Folder is where your site backup (ZIP archives) will be stored. There is a third tab with translation credits, read from the translation file itself. The left navigation panel allows access to the different functions of the component: Options allows you to edit the configuration options that control the backup process. Configuration Migration allows you to backup and restore JoomlaPack's entire configuration set (options and filter options), as well as to fix absolute paths stored in filter settings in case you've migrated your site to a different location or host. Exclude Directories allows you to select whole directories that will be excluded from the backup. This is very useful if your host keeps access statistics in the web server's root (a very common practice these days). Single File Exclusion lets you forbid specific files from being included in the backup. This is useful for excluding host-specific files, that large video file in the downloads section, etc. Exclude DB table allows you to specify which tables from your site's database will not be included in the backup. This is useful for excluding tables belonging to non-joomla! Scripts (i.e. a forum). Multiple DB backup lets you include other MySQL databases besides the one Joomla.These databases will be dumped verbatim, no filters will be applied. Backup now does all the magic, as it navigates to the screen where the actual backup process occurs. Administer Backup Files lets you administer your backup files (download, delete) through a handy web interface. View Log allows you to view the log file for the most recent backup session. Cleanup and Reset Locks will try to clean up any temporary files JoomlaPack knows about and remove the lock from the database. It is intended to recover and clean up after a failed backup. Page 12 On the top of the page you can see if the configuration file is writeable (green text) or not (red text). Temporary directory is where you want the component to store some temporary files during the site packing operation. Important! When you use Clean up and Release Locks a secure.htaccess is written on the temporary directory, disabling browser access to it. This might render your site inoperable if you're not careful. Do not use your site's root or any other folder meant to be accessible from a browser as a temporary directory. You might want to use an off-site directory for maximum security whenever possible. Archive name template controls the name that will be used for the backup file, but without an extension. The template name can contain any of the following macros in any order and quantity. The macros are expanded only at the time the backup procedure starts (file list creation) and can be used to make the backup name much less obvious to malicious users. The options are: Errors only. JoomlaPack reports only fatal errors that cause the backup to fail. Errors and warnings. JoomlaPack reports fatal errors that cause the backup to fail and warnings, such as unreadable files or directories that will not be included in the backup archive (highly recommended). All Information. Detailed step-by-step log of all JoomlaPack operations. All Information and Debug. JoomlaPack will log step-by-step all of its operations, plus any debug information useful when submitting bug reports. None. No log will be kept (not recommended). Page 14 Database export style. In the event that the host on which you will restore your backup is different than the host which you are taking the backup from, this option might come in handy as it sets the target version the exported MySQL snapshot will be compatible with. This option has only effect to newer versions of MySQL (I think 4.1 at least), otherwise it will be silently ignored. The available options are: Default compatibility (default). JoomlaPack will not try to take corrective actions on the exported backup. If you're running on MySQL 5.0 or later and then try to restore on an older version of MySQL the restoration process will halt with SQL errors. Force MySQL 4 Compatibility. JoomlaPack will try to get a backup of your database that is compatible at least with version 4.0 of MySQL. Specifically, it disregards extended MySQL table options (i.e. character set, type of MySQL engine, etc.) so that earlier version of MySQL do not choke on the file when creating the tables. Use this on MySQL 5 or greater hosts only, please. Database backup algorithm. This option can accept two settings and determines how JoomlaPack works to take a snapshot of your database. Page 15 Since the component has to perform a whole lot of steps, it becomes very slow, but it should never time-out under regular usage. Using this algorithm, if the server imposes a limitation on the number of times per second any script may run, this might cause the process to fail for no apparent reason. It will also fail on server cluster hosts which inherently impose a hard limit on database operations per second. Then, it will stop and call a new AJAX step or page load to proceed with the rest of the operation. If it detects a very restrictive server it performs exactly like the Slow algorithm. This is the recommended setting, unless you run into reproducible time-out related problems. File packing algorithm. This option can accept two settings and determines how JoomlaPack works to scan your site's file system hierarchy and put the files into the backup archive. The two options, Slow and Smart work in the same fashion as with the database backup algorithm. File list engine lets you chose the back-end JoomlaPack will use to scan your site's file system hierarchy for files. Please refer to section 4.1 File list engines for more information. Database backup engine lets you chose the back-end JoomlaPack will use to dump the contents of your database(s) to SQL dump files. Please refer to section 4.2 Database backup engines for more information. Archiver engine lets you chose the back-end JoomlaPack will use to put your site's file into an archive or, generally speaking, to the backup media. Please refer to section 4.3 Archiver engines for more information. Installer Included in Archive. JoomlaPack Installer 3 (for Joomla! 1.5.x). This option is available only with the -j15 package. It is an installer based on the standard Joomla! 1.5.x installer, modified to cater for big database dumps and JoomlaPack's multiple database backup feature. It will only work with Joomla! 1.5.x sites. JoomlaPack Installer 2.0 (compatible with Joomla! 1.0.x and 1.5.x). This is an installer written from scratch, designed to be able to restore Joomla! 1.0.x and 1.5.x sites alike, even with huge databases, keeping the original configuration settings. JoomlaPack Installer 1.0 (derived from standard Joomla! Installer). Derived from the Joomla.Backend backup method lets you choose how JoomlaPack will instruct your browser to navigate through the backup steps. Page 16 This is the original method, using AJAX calls to navigate between steps. It is very fast but needs Javascript enabled, an AJAX-compatible browser and nothing interfering with the process (such as firewalls, security suites, free hosts which impose popup ads etc.). This method will work on 90 of occasions. Javascript Redirect will reload the backup page after each step using a small Javascript fragment instructing the browser to reload the page. This lets you use the component with non-ajax browsers, or with websites which interfere with AJAX calls. Force database keep-alive during long operations. Some servers irrevocably drop the database connection to scripts running over a predefined period of time without database traffic. This period is usually very small, in the area of 5-10 seconds. To this end, we have implemented a smart feature which will try to generate database traffic every half a second if you turn this option on. Important! Please make sure you take a look at the Security concerns chapter for a more in-depth discussion of security issues regarding the JoomlaPack configuration Frontend The Frontend options control the behaviour of the front end backup. Enable front-end backup, if checked the front end backup capability is on. When unchecked, the front end backup is not possible. Page 17 The calling process must provide the secret word in order to perform a backup. Important! The secret word is not so secret as it looks. It is transmitted in clear text when calling the backup script, so anybody who can eavesdrop on your Internet connection can find it out. It is therefore not advisable to use your administrator password or any other security-related key you use anywhere else Magic Numbers The Magic Numbers section is the ultra-advanced configuration section of JoomlaPack. The values in this section let you fine-tune the behaviour of various aspects of the backup process. They are meant to be changed by advanced users seeking performance gain or combating time-out problems not possible to solve otherwise. Maximum database rows dumped per step. This has effect on the default database dump engine and defines the maximum number of rows of a single table which will be extracted in a single step. If you have tables with huge amounts of data per row, it is wise to set this to something significantly lower, let's say 20, in the expense of a slower backup process. Page 18 Effective in default file list engine. This determines the maximum amount of data to write to the archive in a single step. This defaults to 1Mb, but on very restrictive or slow hosts this might lead to time-outs. You can try setting it to a smaller value in such a case, in the expense of a slower backup process. If you feel adventurous, you can set it to a bigger value to speed things up, but beware of time-outs. Maximum number of files in a single fragment. Effective in default file list engine. Similar to the above, a single step might be interrupted before the total size is met, as long as the number of files set here is reached. This allows JoomlaPack to efficiently backup large directories with a big number of small files. In such a case, the time spent to put each individual file in the archive that is, updating the archive's data structures is more than the time taken to actually read the file. This value is sane enough, but if the process halts with unexpected time-outs, you might want to lower it to something like 20, or even 10. If you have a generous, fast host you could try setting it to 100 or even 200 to speed things up. Effective in ZIP and JPA archiver engines. On a few buggy hosts or on hosts with weird settings this might not work as expected. Selecting this options overrides JoomlaPack's default behaviour and always uses a conservative method for reading the files to be archived. Do not compress files over this size (in bytes). Both formats use the GZip library to compress files before putting them into the archive. However, compression takes a significant amount of time and it won't result into significant space gains when applied to certain file types (e.g. archives, media files, ISO images, etc). In order to save time and avoid timing out, JoomlaPack will store files of size equal or greater to this value uncompressed. If you have a very slow host you might want to reduce it to about a half. Increasing it is not really recommended. Maximum chunk size for ZIP Central Directory glueing. Effective in ZIP archiver engine. A ZIP file consists if two parts: the data section, where compressed file data is stored and the Central Directory section where a packing list of all files contained in the archive is stored. In order to achieve a speedy operation, JoomlaPack stores these two parts as two physically different files and glues them together at the end of the backup process. This value indicates how much data of the Central Directory will be read at a time when glueing together these two parts. If you have a very low memory limit you should reduce this value to something much smaller, about a fourth of the default. Increasing it is not recommended. Effective for the Smart algorithm. JoomlaPack tries to determine the maximum execution time allowance of PHP before running anything under the smart algorithm. It is possible that your installation does not report this value, or that it has no limit. Imposing no time limit will, on the first case, lead to PHP timeouts, on the other case it can lead to web server time-outs. This setting defines the maximum execution time JoomlaPack will allow the smart algorithm to use. Of course, if the PHP setting is lower, that value will override the setting here. If you are on a restrictive or slow server, you might want to lower this to a value between 5 and 10. Page 19. If the maximum allowed execution time reported by PHP is lower than this setting, the Smart algorithm will fall back to the Slow algorithm, to avoid potential time-outs. This setting is too conservative per default. If you are on a very slow server, please use the Slow algorithm instead of tweaking this value instead. JoomlaPack knows how much time has elapsed between two individual steps. This amount is calculated by maximum execution time times run time bias divided by 100. If the Smart algorithm fails all the time, you might want to lower this setting to 50, or an even lower value mysqldump The options on this section are effective for the mysqldump database backup engine. The available options are: Absolute path to mysqldump binary. The absolute path to the executable file of the mysqldump command-line utility. You might need to ask your host for that.During post-processing, the raw mysqldump raw file is read in small chunks, individual queries are identified and post-processed. This setting defines how many bytes will be read off the file at once. Keep it low to avoid memory exhaustion errors, or set it to a higher value to speed up the execution. Maximum number of lines a query can have. This determines the maximum number of lines in the raw mysqldump file which can be regarded as part of a single query. This setting is generous enough, unless you have a huge table with dozens of columns and a lot of indices and keys. Maximum number of lines to process per step. How many queries to post process in a single step. Post-processing requires a significant amount of time. The default value is good for most servers, but if you are on a restrictive host or have some very big database rows (for instance, huge articles), you might want to lower it to 50, or even 20, just to be on the safe side. 3.4 Configuration migration One of Joomla!'s most frustrating aspects is that it offers no way for upgrading components to a new version. One has to deinstall the older version first, then install the new version. This process invariably deletes user's options, whether they are stored in configuration files inside the component's directory, or they are stored in the database. Having to redo all of the configuration from scratch varies from trivial (sites which usually keep just the default settings) to cumbersome. To overcome this annoyance, we came up with the idea of backing up and restoring your entire JoomlaPack configuration, including options and filter settings. These operations are done from within this page. The Configuration Migration page is a control panel, consisting of these options: Export configuration as XML. Upon clicking on this button, your entire JoomlaPack configuration (options and filter settings) are packed in an XML file which is sent to your browser. You can store anywhere you please for safekeeping. Page 21 22 Import configuration from XML. Loads the configuration restoration page, where you can select the configuration backup XML file to upload. Upon uploading, JoomlaPack will delete your current configuration and replace it with the configuration stored inside the XML file. Fix filters' paths. When you migrate your site to a new location or an entirely different host, the absolute paths to Joomla!'s directories have changed. JoomlaPack stores absolute paths as part of filter specifications. Upon clicking on this button, JoomlaPack will detect the old and new paths and update the stored absolute paths if necessary. JoomlaPack is able to do so by storing the current absolute path in its configuration file. Important! This is a beta feature. This means that it has undergone minimal testing and it is very probable that it has yet undiscovered bugs. Please use it and report any anomalies to our user support forum. You are advised to export your configuration before using this button, so that you are able to revert to you old settings should anything go wrong. 3.5 Exclude Directories Let's say you have a downloads folder with a size of 10Gb you don't want to backup every time. Or, maybe, your host saves Apache logs in your site's root so that they can be accessible by the provided analyser script. Possibly, you have another script (for example, a forum, a torrent tracker, you name it) in a subdirectory of your site's root or even buried deeper in the directory structure that you don't want to backup. Anyway, you need to exclude the contents of a directory from your backup. This is where the Directory Exclusion Filters fit the bill. Directory Exclusion Filters (DEF for short) is a utility function that lets you select which directories to exclude from the backup. All you have to do is filter out a directory and you can rest assured that this directory and its subdirectories will be missing from your backup. The whole process is done in an explorer-like interface; point, click, done. To activate the interface to Directory Exclusion Filters, click on Exclude Directories from Backup from the component's start page. You'll get a page like the following: Page 22 23 In order to exclude a directory, just tick (by clicking) the check box next to the directory's name. The directory name becomes black and can't be clicked.