Installation Guide

Kusaba X Requirements

The absolute minimum requirements for Kusaba X are:

  • A PHP-capable webserver (Apache, nginx, lighttpd, IIS). Apache is reccomended.
  • A user running at least version 2 of Common Sense
  • PHP 5 or greater with support for MBStrings and support for either SQLite, PostgreSQL, MySQL, or MySQLi. MySQLi is reccomended.
  • If you use MySQL, version 4.1 or better is required.
  • If you use PostgreSQL only version 8 and up has been tested and confirmed to work.
  • If you plan to use the load balanacer or have embedding support, Curl support is also required.

Choosing the right Database software

Short version

Use MySQLi

Long version

Does your server not meet the requirements for neither MySQL nor PostgreSQL, or do you run a small server and don't wish to install either? Use SQLite. It requires no database software to be installed, only PHP and a webserver.
If this is the first time you've ever heard of PostgreSQL, stick with MySQL.
If you've used PostgreSQL before and have it installed on your server and PHP supports it, feel free to use it. Kusaba X has full support for PostgreSQL.

Further reading on MySQL vs. PostgreSQL can be found here

MySQL or MySQLi

MySQLi stands for MySQL Improved. MySQLi has been known to give better speed and performance than MySQL. If your server supports it (likely), use it over MySQL. If you get any errors connecting while using it, your server does not support it, and you must use MySQL.

Extracting Kusaba X

  1. If you are installing for the first time, download the latest FULL release from the Sourceforge project. If you are upgrading from a previous version of Kusaba or Kusaba X, download the latest UPGRADE package.
  2. Extract the files to a directory that your webserver has access to.
  3. Make sure that the file permissions are readable and writable by your server.
  4. Edit config.php

Editing Config.php

To enable a feature, change its value to true

  • $cf['KU_STYLESWITCHER'] = true;


To disable a feature, change its value to false

  • $cf['KU_STYLESWITCHER'] = false;


To change the text value of something, edit the text that is in single quotes

  • $cf['KU_NAME'] = 'Kusaba X';


For instance, if your boards name was Awesome, it would now look like this

  • $cf['KU_NAME'] = 'Awesome';


Warning: If you plan on using single quotes in the name, you must first escape them.

  • $cf['KU_NAME'] = 'Guy\'s Imageboard';


There are several variables that must be set for Kusaba X to work. These are KU_ROOTDIR, KU_WEBFOLDER, KU_WEBPATH, and KU_DOMAIN. Read the comments that go with them to find out what to set them to.

Non-Apache Installs

If you don't use Apache, there are some things you'll need to know:

  • You will lose no-read ban support. No-read bans are designed to work with Apache's .htaccess file. Normal bans will still work fine.
  • You must rename kusaba.php to index.php
  • $cf['KU_FIRSTPAGE'] must be set to index.html

Setting up Kusaba X

  1. Edit KU_DBTYPE, KU_DBHOST, KU_DBDATABASE, KU_DBPASSWORD, and KU_DBPREFIX in config.php
  2. Move the files install.php,install_DBTYPE.php, and kusaba_freshinstall.DBTYPE.sql into the root directory. DBTYPE is the database type you are using. MySQL and MySQLi both use the MySQL installation files, and all PostgreSQL settings use the same PostgreSQL installation files.
  3. Run install.php, and do everything that it says.
  4. Log into yoursite/manage.php with the default admin account (Username: admin, Password: admin). Create a new administrator account, and delete the old one.
  5. Delete the /OTHER/ directory. Delete install.php, install_DBTYPE.php, and kusaba_freshinstall.DBTYPE.sql.

Upgrading

From Kusaba X 0.8

  1. Get the 0.9 upgrade package here. BE SURE THAT YOU HAVE THE UPGRADE PACKAGE. WITHOUT THIS PACKAGE IT WILL NOT WORK
  2. Backup config.php
  3. Upload the contents of the package.
  4. Update the new config.php with the values from your old one.
  5. Copy the contents of /OTHER/ to the root directory of your install.
  6. Run update-mysql.php
  7. In update-mysql.php, you have the option of saving your old posts database files
  8. If all went well, your database should now be current, and ready to run Kusaba X! Delete /OTHER/, kusabax_updatemysql.sql, and update-mysql.php, and enjoy!

From Serissa 1.2

  1. Make sure your Serissa install is up to date. The script is designed to work with version 1.2 of Serissa.
  2. Get the 0.9 FULL package here. BE SURE THAT YOU HAVE THE FULL PACKAGE. WITHOUT THIS PACKAGE IT WILL NOT WORK
  3. Backup config.php
  4. Extract the files that you downloaded where you want them installed. Overwrite everything.
  5. Redo 0.9's config.php using the values from the config.php you backed up. DO NOT USE SERISSA'S config.php WITH KUSABA X. IT IS INCOMPATIBLE
  6. Delete /lib/mysql/ from the server.
  7. Copy s2kx.php, s2kx.sql, kusabax_updatemysql.sql, and update-mysql.php from /OTHER/ to the folder containing config.php on your server.
  8. Run s2kx.php
  9. Run update-mysql.php
  10. If all went well, your database should now be current, and ready to run Kusaba X! Delete /OTHER/, s2kx.sql, kusabax_updatemysql.sql, s2kx.php, and update-mysql.php, and enjoy!

From Kusaba 1.0.4

  1. Get the 0.8 upgrade package here and the 0.9 upgrade package here. BE SURE THAT YOU HAVE THE UPGRADE PACKAGES. WITHOUT THESE PACKAGES IT WILL NOT WORK
  2. Backup config.php
  3. Upload the contents of the 0.9 package.
  4. Update the new config.php with the values from your old one.
  5. Copy the contents of /OTHER/ from the 0.8 package to the root directory of your install.
  6. RENAME kusabax_updatemysql.sql TO kusabax_update.sql
  7. Run update-mysql.php
  8. Copy kusabax_updatemysql.sql and update-mysql.php from the /OTHER/ directory of the 0.9 package to the root directory of your install, overwriting the old update-mysql.php file.
  9. Run update-mysql.php
  10. If all went well, your database should now be current, and ready to run Kusaba X! Delete /OTHER/, kusabax_update.sql, kusabax_updatemysql.sql, and update-mysql.php, and enjoy!
 
installation_guide.txt · Last modified: 2010/05/18 16:48 by harrison
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki