Location: PHPKode > projects > Burning Board > Read me.txt
WoltLab® Burning Board® Lite 2 Installation Guide

Table of contents:
  I. Introduction
     1. Foreword
     2. Quick instructions for advanced users
     
 II. Installation
     1. System requirements
     2. Preparations & considerations
     3. Installation procedure
     
III. Update from Burning Board® 2.x or Burning Board® Lite 1.0.x
     1. Requirements & Preparations
     2. Procedure
     3. Update counters
     
 IV. Data transfer from other forum systems
     1. Supported systems
     2. Requirements & Preparations
     3. Procedure
     4. Update counters
     
  V. First steps
     1. Foreword
     2. Set up general forum options
     3. Configure the forum e-mail adress
     4. Add categories and forums
     5. Add users
     6. Set up forum permissions
     7. Customise the forum design
     
 VI. Definitions
     1. WoltLab® Community Framework
     2. WoltLab® Burning Board® Lite 2
     3. Admin Control Panel (ACP)
     4. Character encoding
     5. Administrator
     
     
----------------------------------------------------------------
I. Introduction

1. Foreword
WoltLab Burning Board Lite 2 is the modern, secure and user friendly solution for your discussion board! Our software uses most modern internet technologies and is built upon up-to-date web standards. For this reason you will notice, that the installation procedure, which is quite different from other or older forum systems, behaves similar to an installer for "real-life" applications on a typical PC system. You don't need any programming or database knowledge, the installer handles everything nearly automatically.

Be sure to read this installation guide carefully before installing, to clear ambiguities and avoid difficulties with the installation process. Also pay attention to the system requirements!

2. Quick instructions for advanced users
Unzip the downloaded Zip archive, upload the three files from "upload" subdirectory to your web space, open the file "install.php" in your browser and follow the instructions ...


----------------------------------------------------------------
II. Installation

1. System requirements
Requirements for installing WoltLab Burning Board Lite 2:
- Web server with PHP 5 support
- Apache 2 with PHP 5.2.x module recommended
- MySQL database at version 4.1.2 or better
- A minimum of 6 MB free hard disk space
- A FTP program, for transferring the installer files onto your web space

Note: It's not possible to run WoltLab Burning Board Lite 2 using PHP below version 5.0!

2. Preparations & considerations
Before starting the installation, you may spend some time thinking and planning the object of your project, as well as figuring out the structure of your forum and maybe which parts should be public and which not. Make sure that your web space fulfils the system requirements. Decide which folder of your web space your forum should be installed to. What should the forum URL be like, will you use a sub domain? Will you have to transfer any data from your old forum? Which plug-ins or other extensions do you need and are they already existing?

3. Installation procedure
3.1 Unzip the Burning Board Lite 2 archive
After downloading the installation archive ("wbb3.zip") to your hard drive, unzip it either with a special application (e.g. "WinZip" or "StuffIt Expander") or simply with the unzipping function built in your operating system. Most modern operating systems, like Windows Vista or XP, Mac OS X and Linux, can handle Zip archives out of the box without any helper application needed.

You'll get these files:
- upload/test.php
- upload/install.php
- upload/WCFSetup.tar.gz
- License agreement.txt
- Lies mich.txt
- Lizenzbestimmungen.txt
- Read me.txt

Beware! The file "WCFSetup.tar.gz" is also an archive, but you should not unzip it! This archive contains the "WoltLab Community Framework", which the also contained package "WoltLab Burning Board Lite 2" depends on. The contents of this "tar.gz" archive will be automatically extracted and read by the installation script.

3.2 Upload the installation files
Simply upload the three files from "upload" subdirectory with your FTP program to a subdirectory of your choice on your web space. Consider uploading the files to the directory, where you want your forum to be installed into later. The installation assistant will later suggest a sub folder of your chosen folder as actual installing directory for WoltLab Community Framework and WoltLab Burning Board Lite 2, but you can of course change it as you like.

3.3 Verify the system requirements
In case you are not sure if your web space fulfils the system requirements, consider testing the PHP support first! All you need to do so is opening the file "test.php" in your browser and see the results. E.g. "www.my-testserver.com/test.php" (replace "www.my-testserver.com" with the name of your server). If your server doesn't meet the system requirements, you may contact your provider to ask for some solution, or switch the provider in the worst case.

3.4 Installation start
Start the installation by loading the installer file ("install.php") in your browser. E.g. "http://www.my-testserver.com/install.php" (replace "www.my-testserver.com" with the name of your own server).

3.5 Installation process
Please note that the progress of the installation script can vary from time to time – do not cancel this process too soon. This behaviour is completely normal. The duration of the installation depends on many factors such as your Internet bandwidth, the server speed and load as well as the chosen packages.

The installation process in basic steps:
- After starting the installation assistant you can choose the language of the assistant. Your browser's language will be automatically suggested.
- Before starting the installation process you must accept the WoltLab license agreement.
- After that a screen will inform you about system requirements and found system components. Note the colour code, where Red displays indicate, that an installation is not possible, because a system component is not at the correct version. With Yellow indicators an installation is possible but not recommended. You might contact your system provider and ask for an update of the specific component. Green indications show that the components meet the requirements.
- Please choose the installation folder of the WoltLab Community Framework. The assistant suggests a default folder, which can be changed to your needs. Please note that this does not equal to the installation folder of Burning Board Lite 2. That folder will be asked later, but note, that is is dependent from what you have entered here!
- During the next step you select the desired character encoding and the languages to be installed. Please note that the chosen character encoding cannot be changed later, so please choose it carefully! Some languages are not supported by certain encodings, so you may have to alter your encoding selection. "UTF-8" will support all languages. WoltLab Community Framework automatically converts the encoding, if you choose to import data from other systems in different encodings later!
- In the next step you need to specify your database access data. Please enter the required information and the password for your (new) installation. Your provider should have told you the required information for database access, if not, ask him to tell you. In certain cases an existing database can be used.
- During the next step the Administrators account will be created. This user account is required to access the Administration Control Panel (ACP) and to alter the settings. You can change the login details later.
- Please choose the installation folder for WoltLab Burning Board Lite 2 afterwards. The assistant suggests a default folder, located on the same level, as the installation folder of the WoltLab Community Framework. You can change the suggested folder to your needs. If you want to install Burning Board Lite 2 without a sub folder (e.g. "www.my-testserver.com/wbb") directly on a top level domain (e.g. "www.my-testserver.com"), you need to have the files uploaded into the "home directory" of your server and just remove "/wbb" from the file path. 
- With the last major step you can select optional packages to be installed, such as an appropriate Importer plug-in to import data from an older existing or different forum software (read more below).


----------------------------------------------------------------
III. Update from Burning Board® 2.x or Burning Board® Lite 1.0.x

1. Requirements & preparations
An update from an older version of Burning Board is quite similar to a data import from a different forum system (see below). If you wish to import data from your current older Burning Board version on the same server into a newly installed Burning Board Lite 2, then follow these steps:
Install WoltLab Burning Board Lite 2 into a separate folder on your server first. Then install the appropriate Importer plug-in from WoltLab for your old forum system within your Burning Board Lite 2 ACP.

2. Procedure
Use the previously installed appropriate Importer plug-in to import the data from your older Burning Board version.
You'll find it in the WoltLab Burning Board Lite 2 ACP under: "System" -> "Maintenance" -> "Data importer".
Just follow the instructions. Please keep in mind, that the duration of the import process depends on many factors, like quantity of forums, posts and attachments in your old forum system, but also many other factors. Do not abort the procedure too early!

3. Update counters
After you have finished the data import, you should update the counters. This procedure updates the post counter, the ranking system, the user list and many other parts of the software. To do so, use the ACP function found under "System" -> "Maintenance" -> "Update counters". An option to updated all counters at once is not available, because of the high server load it would generate on big boards.


----------------------------------------------------------------
IV. Data transfer from other forum systems (vBulletin, phpBB ...)

1. Supported systems
You can import external data from many other forum systems at any time, with one of the WoltLab Importer plug-ins. At this time, the importers support the following forum systems:
- Invision Power Board (IPB) 2.0.x, 2.1.x, 2.2.x
- MyBulletinBoard (MyBB) 1.2.x
- phpBB 2.0.x
- PunBB 1.2.x
- Simple Machines Forum (SMF) 1.1.x
- vBulletin (vB) 3.0.x, 3.5.x, 3.6.x

2. Requirements & preparations
If you are currently using a different forum system and you want to import its data into a newly installed Burning Board Lite 2 on the same server, simply do the following: 
Install WoltLab Burning Board Lite 2 into a separate folder on your server first. Then install the appropriate Importer plug-in from WoltLab for your old forum system within your Burning Board Lite 2 ACP.

3. Procedure
Use the previously installed appropriate Importer plug-in to import the data from your existing board software.
You'll find it in the ACP under: "System" -> "Maintenance" -> "Data importer".
Just follow the instructions. Please keep in mind, that the duration of the import process depends on many factors, like quantity of forums, posts and attachments in your old board system, but also many other factors. Do not abort the procedure too early!

4. Update counters
After you have finished the data import, you should update the counters. This procedure updates the post counter, ranking system, user list and many other parts of the software. To do so, use the ACP function under "System" -> "Maintenance" -> "Update counters". An option to updated all counters at once is not available, because of the high server load it would generate on big boards.


----------------------------------------------------------------
V. First steps

1. Foreword
After you have finished the installation successfully, you will find yourself in the Administration Control Panel (ACP) of WoltLab Burning Board Lite 2. You can now start to set up the system according to your needs. If you have done a fresh installation, you can start off setting up the e-mail address, naming the forum or creating the forum structure (categories and forums). You'll find a short list of important options below. To better find your way to the needed section, also try the handy site map, which can be found in the page header.

2. Set up general forum options
Forum name, URLs, Cookies, Sessions, etc.
"System" -> "Options" -> "General"

3. Configure the forum e-mail adress
Needed for system e-mails, like user registration confirmation mails
"System" -> "Options" -> "E-mails"

4. Add categories and forums
"Content" -> "Forums" -> "Add new forum"

5. Add users
"User" -> "Users" -> "Add new user"

6. Set up forum permissions
"Content" -> "Forums" -> "Show forums" -> Click on the name of a forum or category -> Choose the tab "Permissions for users and groups".
Enter the name of a usergroup or username into the textfield (if a user- or groupname starting with the typed characters already exists, the field will be filled out automatically) and add it to the box "Group and usernames" above by clicking the appropriate button. Select the new item there and then set the permissions in the box "Permissions for …". Please note that an Allow setting overrides a Deny setting!

Of course you can always refine the permission settings by using more detailed permissions for forums, user groups or single users. Also consider adding custom user groups with special permissions. Keep the permission inheritance system in mind, as it helps you to set up permissions faster!

Example:
If you want to set a forum only visible and accessible for Administrators, you simply need to do the following:
Enter the name "Administrators" (if not already listed in the box "Group and usernames") and click on the "Add" button, which adds the new name to the box above. Repeat this process with the group "Everyone". Now select "Everyone" there and deny "Full control" in the box below. Then select "Administrators" and allow "Full control". Now only administrators have access to the edited board!

7. Customise the forum design
"Design" -> "Styles" -> "List styles"


----------------------------------------------------------------
VI. Definitions

1. WoltLab® Community Framework
Is a software framework and also the backbone of all community based web applications from WoltLab. It can be imagined as the operating system powering Burning Board Lite 2. Burning Board Lite 2 uses many components of the Community Framework, which is available for free under LGPL. Find out more about WoltLab Community Framework can at: http://www.woltlab.com/wcf/

2. WoltLab® Burning Board® Lite 2
Is a free package for the WoltLab Community Framework and a modern, powerful and vastly extensible forum system. You'll find further information about WoltLab Burning Board Lite 2 at this adress: www.woltlab.com/products/burning_board_lite/

3. Admin Control Panel (ACP)
This is were settings, modifications and updates of your installed web application, such as Burning Board Lite 2, can be done in WoltLab Community Framework. All community applications from WoltLab have their own ACP.

4. Character encoding
In the Internet, Text is transmitted as an encoded data stream, that is readable by computers only. To decode this to make it readable text for you, the browser needs to know the used encoding. The encryption method is called character encoding, it will be recognized automatically by your browser, if the encoding type is found in the source code of a HTML document. Specific languages need certain character encodings. Find further information about character encoding in Wikipedia: http://en.wikipedia.org/wiki/Character_encoding

5. Administrator
The main user of an application or operating system is normally called Administrator. He has the most rights and manages the application and its users. During the first installation of a community based application, like WoltLab Burning Board Lite 2, you need to create at least one user account which is automatically the administrator account.


----------------------------------------------------------------

Have a nice time with our forum software!
Your WoltLab-Team!

----------------------------------------------------------------
Copyright (c) 2007 by WoltLab® GmbH, all rights reserved.

WoltLab® and Burning Board® are registered Community Trade Marks at The Office of Harmonization for the Internal Market (OHIM) in Alicante, Spain.
Return current item: Burning Board