UseBB 1 Readme

Welcome to the UseBB 1 introduction document. This file gives some general information regarding UseBB, how to install/upgrade, etc.

• What's UseBB?
• Install UseBB 1
• Upgrade an existing UseBB
• More information

What's UseBB?

UseBB 1 is an Open Source forum package developed in PHP 4 and using the popular MySQL database back-end to store data. Unlike other popular forum systems, UseBB does not strive to have as many features as possible, but to be the easiest and most usable forum package, limiting the basic feature set to only the essential. UseBB is pure forum software.

UseBB is an ideal solution for small to medium-sized websites which require an easy to use forum package without the bloat, that produces standards compliant output, is secure and easily configurable.

For a list of features, see the feature list at UseBB.net.

Install UseBB 1

Before you install UseBB 1, you have to make sure your host accords to the following system requirements.

Minimum requirements

• HTTP server supporting PHP
• PHP version 4.1.0, including session, PCRE and mysql extensions
• MySQL version 3.23

Recommended set-up

It is highly recommended to use UseBB 1 on the following set-ups.

• GNU/Linux operating system
• Recent Apache HTTPD version, including mod_rewrite
• Recent PHP version, including session, PCRE, mysql(i) and curl extensions
• Recent MySQL version

Important: If you use MySQL 4.1 or higher, it is highly recommended to use a latin1 collation instead of a Unicode one. Should your host use Unicode as default database collation, please change this for your database using phpMyAdmin or a similar administration tool or contact your host before installing UseBB 1. In most cases though, no action will be necessary.

To install UseBB 1, you have two options.

Note: You must choose only one of the following installation methods. You don't have to follow both lists of steps. If you don't know what to choose, perform the automatic installation.

Automatic installation

The automatic installer is mostly the best and easiest method to install UseBB 1.

1. Rename config.php-dist to config.php;
2. Upload/move all the files to their final destination online;
3. Optional but recommended: chmod config.php so that it is writable by the webserver (try chmod 0777);
4. Open the installation wizard in your web browser (located at install/).

Manual installation

Alternatively, you can install UseBB 1 manually.

1. Execute install/schemas/mysql.sql and install/usebb.sql on your database (using a database management tool such as phpMyAdmin);
2. Rename config.php-dist to config.php;
3. Edit config.php and adjust the database settings;
4. Upload/move all the files to their final destination online;
5. Optional but recommended: chmod config.php so that it is writable by the webserver (try chmod 0777);
6. Register a first user, it will automatically be an administrator.

When this is done, you can log in and start configuring your forum.

Upgrade an existing UseBB

If you run a forum powered by a previous UseBB 1.0 version, you can upgrade as following:

• Reupload all changed files. There is a separate package only containing new and changed files.
• OR apply the patch found in the separate download file usebb-<version>.diff. The patch can be applied using GNU patch or using a compatible tool.
• Alternatively, you can also reupload all files (except config.php).

Separate download files can be found at www.usebb.net/downloads.

More information

Developer's notes

• While there are Unicode patches applied to the source, Unicode remains officially unsupported in UseBB 1. Please use Unicode (UTF-8) based translations at your own risk.
• At this time, the next version of the UseBB forum software is under development. UseBB 2 is written in PHP 5 and thus will not be usable on PHP 4, which is what most people use nowadays. Our limited userbase has permitted us of making this migration towards PHP 5. However, bug fix releases for UseBB 1 will still be made for an unspecified amount of time (as long as PHP 4 is officially supported). If you wish to be able to upgrade to UseBB 2 in the future (which is highly recommended), please make sure your host is able to run PHP 5.2 or newer.

External links

If you would like more information about UseBB, check out the following locations.

• UseBB.net for general information, news, downloads, etc.
• The community forums for help, (development) discussion, etc.
• Recent developer information can be found at the dev center.