Friday, July 30, 2010
   
Text Size

Advanced Kickstart topics

Rate this item
(2 votes)

Advanced Kickstart topics

This section covers some specialized uses of JoomlaPack. Normal users shouldn't need them, but they can save you a lot of time. Remember that, due to the infinitely varying server setups, the key to success is trial and error. All of the solutions described below have been attempted by yours truly, with successful result, on live sites. However, you needn't share the author's optimism; on the contrary, we strongly suggest you to test these ideas on a local testing server before applying to a functional, live site.

Fine-tuning Kickstart

Most of the previously well-hidden Kickstart fine-tuning parameters are now available in its starting page. However, a few more esoteric fine-tuning features are only available

Kickstart is a fine and fast solution on its own right, but people usually want to squirt every last drop of performance out of software. Kickstart offers some advanced tweaking options which might increase its performance or, conversely, sacrifice performance to better compatibility. Applying these tweaks requires editing the kickstart.php file. All the tweaking settings are set with "define" statements at the top of the file.

[Warning]Warning

Changing these settings might cause the extraction process to fail, depending on your server's setup. You are strongly advised to test these settings in staging sites or running them with DRYRUN first.

The available settings are:

  • DRYRUN . When set to 1, Kickstart will not write any files to disk. This can be used to run Kickstart in simulation mode in order to evaluate the influence of other tweaking options, without risking overwriting useful files should the process fail.

Upgrading your Joomla! site the easy way

As stated in the first section of the Kickstart documentation, Kickstart is a very versatile utility whose primary objective is to extract archives directly on the server. It is not restricted to JoomlaPack backup archives; it just happens that this is the most common use. One of the most uncommon - yet, very convenient - uses is upgrading your Joomla! site every time the Joomla! team issues a new security or stability release.

The classic approach to Joomla! upgrade is to download the patch archive from JoomlaCode.org, extract it on your local PC, put the site off-line and upload all files through FTP. The problem lies with uploading. FTP is inherently slow, because a lot of overhead data has to be transferred back and forth the server for each file operation. These add a whooping 1 second (on average) for every file! Multiplying this with the number of files in the upgrade package tells us that most of the time we are FTP'ing files is spent in overhead.

Using Kickstart, you avoid this overhead because only two files are uploaded: kicktart.php itself and the upgrade patch ZIP archive. The extraction process takes place in the server, minimizing the amount of overhead and leading in faster upgrades. The procedure outlined below should be carried out with Kickstart 2.0.a1 or later. Remember to unzip Kickstart's ZIP package before uploading! You'll have to upload the kickstart.php file from this archive, not the archive itself!

First, you'll need the ZIP version of the Joomla! patch, which you can download from the Joomla! project's file repository site. Depending on which Joomla! version you've already installed, download the appropriate ZIP file. The tar.gz file will not do! For example, if you've got Joomla! 1.5.6 and want to update to 1.5.7 you must download the Joomla_1.5.6_to_1.5.7-Stable-Patch_Package.zip . Upload the Joomla! ZIP file and kickstart.php to your site's root. If you used FTP, make sure both files' permissions are 0777.

[Important]Important

Make sure you have a working backup of your site before you proceed! In the unlikely event you run into a problem we want to be sure you can roll back. There are many ways to take a backup of your site, but we obviously suggest you to use our open source JoomlaPack backup component.

Now visit the kickstart.php URL, which is something like http://www.example.com/kickstart.php , substituting www.example.com with the full URL to your Joomla! site. In the page presented to you, make sure the update ZIP is selected in the topmost combo box. For the operation method we suggest using the "JavaScript Redirects" method, unless you know what you're doing. Depending on your site configuration you can either use "Write directly to files" or "Use FTP", supplying your FTP connection information as well. Most users will need the second (FTP) option.

After you're done setting up Kickstart, hit the big green "Start" button. You will see your browser reloading the page many times; this is normal, it's how Kickstart works. On the final page, click the second link titled "here". As the page reads, you're (almost) done! If you had an .htaccess file on your site, it is now renamed to htaccess.bak. Using an FTP client, rename it back to .htaccess and you're really done, in - virtually - no more than a few seconds!

Try it! The first time I did it I managed to upgrade two sites in 3 minutes flat (including upload times!).

Installing web applications, the effortless way

Having read so far, it is probably quite obvious to you that Kickstart can effortlessly deploy any kind of web application on your server, as long as it comes in ZIP format. The whole process is very easy and can be summarized in a couple of bullet-points:

  • Grab your favorite web application's ZIP package. We have used Kickstart with Joomla! itself, custom-made scripts written using CodeIgniter, phpBB, a few galleries and the list goes on.

  • Upload this ZIP and kickstart.php to the location on your site you'd like the application to be installed to.

  • Visit the Kickstart URL, which looks something like http://www.example.com/my_location/kickstart.php .

  • Make sure the ZIP file you just uploaded is selected in the combo box. Select any necessary options. If unsure, use the Javascript Redirects mode and FTP.

  • Hit the big green button labeled Start .

  • When the process is over ignore the misleading text and click on the second "here" link. You get a page informing you that you're done. The ZIP file and kickstart.php are removed from your server and you're ready to rock'n'roll.

    [Important]Important

    If your web application has a directory named "installation" it is removed upon clicking the second "here" link. For example, if you are installing Joomla! - which uses the installation directory for its... well... installation - with this process, make sure you click the first "here" link, go through all the Joomla! installation steps and only then you should click on the second "here" link.

Of course your web application might need some configuration files editing or you may have to access some web setup interface. However, the bulk of the installation process - uploading hundreds of files - has been already taken care for you.

Last modified on Wednesday, 17 February 2010 14:39

Sponsored Links

Banner

Support Unavailability

Enhanced Support will experience reduced or no availability during the dates marked in red on the calendar below. If you file a support ticket during this period, we might take longer to get back to you.

Calendar shown in Athens timezone
See the full calendar