QuickDump Documentation

Server Requirements

Your server needs to meet these requirements in order to function:

Because QuickDump is a pure PHP application, it might not work properly on Shared Hosting (those few bucks a year hosting). A VPS, dedicated server or your own hardware should suffice.

Software Requirements

QuickDump has been tested with the following Web Browsers:

It might also work with other browsers.

Installation

  1. Upload the files to your Web Server.
  2. Point your Web Browser to the QuickDump folder
  3. The installation wizard should now start. Follow all instructions.
  4. Step 3 will check if PHP has Safe Mode turned off, and if the permissions are correctly.



    It will usually give an error at the permissions part. You should set the owner of the
    "dumps" folder to the one specified to you during the installation. This is usually
    "www-data", "apache", "www" or "nobody". 



    If you have Shell access, you can easily do this with the following command as root:

    chown -R username /path/to/dumps


    Then set the permissions to Read/Execute for User/Group/World, and Write for
    User/Group (775). If you have Shell access, use this command:


    chmod -R 775 /path/to/dumps
  5. When the installation has been completed, perform these two steps:

  6. You can now launch QuickDump by pointing your Web Browser to the QuickDump folder.

Configuration File

The configuration file comes with the package as config.php.sample. You should set this file accordingly, or don’t set anything as it works fine without any user settings.

When the installation is completed, you are asked to rename your Configuration File to config.php.

If you don’t do this, the application won’t run.

Security Precautions

The first settings let you specify the details of your database. Everything you put in there
will be automatically filled when you perform a Database Dump. You can also store your
password in there. This can be risky, because if some gets access to that file they have
access to your database.

So if it’s possible, please don’t save your password in the file. Enter it everytime you
perform a Database Dump.

However there are some situations where you really need the password to be saved in
advance. Follow one of these steps to protect this file:

Setting the configuration

The configuration file is divided in two sections:

The Database Settings allow you to specify the settings of your database:

Example of config.php

Hostname: The system where the database server is running on. Is the database server running on the same system as QuickDump? Then this is usually localhost or 127.0.0.1.

Name of the database: The name of the database. If you have multiple, then enter the one you will dump most of the time. Remember that these only auto-fill the dump form. You can always change these inside the program.

Username: The username which has the rights to access your database.

Password: The password of the above username.


The File Settings specify the format of the file name for each dump.

File Prefix: The prefix of the files. If you put “myblog_” in this field, then all filenames will start with myblog_.

Date Format: This is the format of the date which is used in the file name. This field is required, and therefore already contains a default value for your convenience.


Here’s a list of most used formats:

Format Example Description
d-m-Y-G_i_s 15-05-2011-16_10_05 European date and time
m-d-Y-g_i_s 05-15-2011-4_10_05 American date and time
d-m-Y 15-05-2011 European Date
m-d-Y 05-15-2011 American date

For more options, look at the “date()” function on the PHP website.

Using QuickDump

The user interface of QuickDump is very easy and clear to understand.

Preview of QuickDump

Server: Location of the Database Server. Is this the same system as QuickDump is running on? In that case, the server is usually “localhost” or “127.0.0.1”.

Database: Name of the database you would like to dump.

Username: Username with the priviliges to access the database.

Password: The password of the username.


Click on Dump Database to create the dump.

When the dump has been completed, click on the Download Dump button to download it.

All dumps are temporarly stored in the folder “dumps”. When you have downloaded the
dump or when you restart QuickDump, all contents of the folder will be removed.

QuickDump will never leave any mess behind.

All input and the file size will be checked. Therefore you won’t end up with an empty dump
in case of an error.

Themes

QuickDump can be customized with themes as of version 0.5. Each theme is stored in the folder themes, inside a folder with the name of the theme. For instance, a theme called MyTheme would be stored in the folder mytheme

The primary theme file is always theme.css. You can use the default or one of the other bundled themes are reference.

To activate the theme, you have to edit the file stylemanager.php. The default one looks like this: stylemanager sample
You should set the name of the folder which contains the specific theme. In our example we would put mytheme here.

At this moment you can change the following elements:

Have a specific theme request? Please let me know

QuickDump comes bundled with these themes:

FAQ

Q: I get an error message when trying to create a dump.
A: Make sure that you haven’t made a type anywhere. Also make sure that the “dumps” folder is writable. You can check this by running the script /sqldump/includes/install3.php

Q: Why is Windows not supported?
A: QuickDump sends commands directly to the operating system. Unfortunately Windows and Linux have different instructions. Because most web servers, PHP and MySQL are mostly run on Linux, I’ve prioritised Linux. I will add Windows support at a later stage.

Q: Why are there problems with Shared Hosting?
A: Shared Hosting is cheap hosting with limited features. Not every hosting company allows you to run scripts that directly access the operating system, mostly for security reasons.

Q: Do you support other databases like PostgreSQL and Microsoft SQL?
A: At this moment, QuickDump only supports MySQL. I will add support for other
databases like PostgreSQL later. Microsoft SQL works with ASP, which requires an entire
different application.

Q: How do I run a command as root?
A: You can do this on either of the following methods:

Q: I found a bug or have request. How can I contact you?
A: Please read the Feedback and Suggestions section below for contact information.

Q: I have a company. Can I use QuickDump for free?
A: Yes, you can. It’s licensed under GPL and I am releasing it for free to anyone who can
use it :)

Q: Can I use QuickDump in my software?
A: Yes, but as long as your software is also licensed under GPL and therefore have its
source code publicly available.

Q: May I sell QuickDump to people?
A: No, absolutely not. It’s a free product, and it may only be distributed for free.

Q: Do you provide any warranty?
A: No, I don’t. This tool might or might not work correctly for you. I create these projects in
my spare time, and therefore can’t provide any support or a warranty. Furthermore I’m not
responsible for any damage to your server or loss of data.

Q: I’m a programmer and would like to donate some of my code to you. How can I do that?
A: Please read the Feedback and Suggestions section below for contact information.

Release Notes

Version 0.5 (April 29 2011)

Issues Resolved:

New features:

Version 0.4 (April 29 2011)

Issues Resolved:

Known Issues:

Version 0.3.1 (April 28 2011)

Issues Resolved:

Version 0.3 (April 28 2011)

Issues Resolved:

Version 0.2.1 (April 28 2011)

Issues Resolved:

Version 0.2 (April 28 2011)

Issues Resolved:

Version 0.1 (April 27 2011):

First Release

Known Issues:


Feedback and Suggestions

Do you have a suggestion, bug report or want to contact me? This can be done in different ways.


Contact page: http://www.royhochstenbach.nl/about/

Twitter: @RHochstenbach

Public Key

QuickDump Project Page