TXT_NAV_20

Installation Guide

Installing Twando is basically a 3 minute job, but there are some more advanced configuration options which are explained in detail below.

3 Minute Install

  1. Download the latest version of Twando from the download page.
  2. Make sure you have a hosting account ready; you'll need to set up a MySQL database also in your hosting control panel if you don't have one already prepared.
  3. Unzip the zip file and rename inc/config-sample.php to inc/config.php.
  4. Update the options in config.php with your required settings.
  5. Upload the entire contents of the folder to a directory on your server, e.g. http://www.yoursite.com/twando/.
  6. Visit http://www.yoursite.com/twando/install_tables.php in your browser.
  7. You'll need to register for a developer account (manual approval is required from Twitter) and then register your application. Full instructions for this are provided at http://www.yoursite.com/twando/. We cannot provide any assistance with your developer account application.
  8. It is entirely possible to use Twando completely within the terms of use Twitter provide for their API, and we would encourage you not to use features that may violate those terms. These additional features are included in Twando for educational purposes only.

Upgrading From a Previous Version (1.x to 1.x)

  1. Upload all files to your Twando install directory, overwriting all existing files.
  2. Copy across any new config values from config-sample.php to your existing config.php.
  3. Remove the inc/config-sample.php file.
  4. Run http://www.yoursite.com/twando/install_tables.php again in case of any database changes (your existing table data will not be lost).
  5. That's it; I wish there was more I could say!

Upgrading From a Previous Version (0.6.x to 1.0.x)

  1. Between versions 0.6.x and 1.0.x, the Twando file structure changed considerably.
  2. It's recommended to upload Twando to a new install directory and copy across your existing config.php settings to your new config.php file.
  3. Finally, run http://www.yoursite.com/twando/install_tables.php again. This will alter the existing tables as required and install the new database tables needed for Twando 1.0.x. No existing database records will be lost.
  4. That's it; sorry if you wanted more!

Detailed Configuration Options

In inc/config.php, there are several options you can configure before installing Twando:

  • DB_NAME
    The name of the MySQL database you will use with Twando
  • DB_USER
    The username of the MySQL user you will use with Twando. This user must have full privileges on the database specified above.
  • DB_PASSWORD
    The password for the MySQL username specified above.
  • DB_HOST
    The host address of your MySQL database. This will usually be "localhost".
  • DB_PREFIX
    All created MySQL tables will be prefixed with this value. This gives you the option to run multiple Twando installs from a single database if you wish. You shouldn't set this to anything longer than 10 characters. Changing this after you install will break the script.
  • LOGIN_USER
    The username you will use to log in to your Twando install.
  • LOGIN_PASSWORD
    The password you will use to log in to your Twando install. Try to use a password that's long and hard to guess.
  • CRON_KEY
    This should be a hard to guess string of characters. This is checked when the cron job files are called; since Twando supports remote http calls to your cron jobs, having this key prevents unauthorised running of your cron jobs.
  • TWANDO_LANG
    Twando has been built to support multiple languages in future; currently this should be left as "english".
  • JS_CONFIRM_BOXES
    In various places, Twando will present JavaScript confirmation boxes when you try and delete something. Set this to false if you don't wish to have any confirmation boxes.
  • TIMESTAMP_FORMAT
    The format the time and date should be displayed in at various parts of the script, using the parameters from PHP's date() function.
  • TWANDO_TIMEZONE
    If you wish to override the default timezone of your server, uncomment this line and specify a valid PHP timezone.
  • BASE_LINK_URL
    The URL of your install, e.g. http://www.yoursite.com/twando/
  • TW_USE_PROXY
    Set to true and configure the related options to enable proxy use.
  • UPLOAD_PATH
    The upload directory relative to the root of your install where media library files will be saved.
  • LICENCE_KEY
    If you're using Twando for any kind of commercial use, you are required to purchase a licence key. Enter that key here if you have one.

You can use the values below in your config.php value. These are randomly generated; refresh the page for new values: