Installation

From FUDforum Wiki
Revision as of 05:04, 16 February 2010 by Naudefj (Talk | contribs)
Jump to: navigation, search
Screenshot of the GUI Installation Wizard

This section describes the process of installing FUDforum on a webserver.

Contents

Verifying your system configuration

Before proceeding with the installation process, it is recommended that you determine that you have all of the software needed for the operation of FUDforum:

  • If you would like to install FUDforum utilizing the MySQL back-end, you will need to ensure that your system has PHP 5.1.0 or greater and MySQL 4.1.2 or greater installed.
  • If you decide to use the PostgreSQL back-end, you will need PostgreSQL 8.1 or greater and PHP 5.1.0 or greater.
  • If you decide to use the SQLite back-end, you will need PHP 5.1.0 or greater (SQLite ships with PHP 5 and later releases).

If you find that the software on your server is older then the one needed for proper installation of FUDforum, you can download the needed programs from the web, the URLs are listed below. MySQL, PostgreSQL, SQLite and PHP are Open Source and you can download and use them for free, without paying any fees regardless of whether you use them for commercial or personal use.

Expand the relevant sections below to learn how these components should be configured:

Obtaining the FUDforum installer

Choose one of the below methods to get an installation program:

Download the installer

The FUDforum installer can be downloaded from https://sourceforge.net/projects/fudforum/files/. This page will always contain the latest stable version of FUDforum as well as the latest development version if you want to test new features. You will need a unzip utility to unpack the files. Unzip utilities (like WinZip) are readily available and you should not have any problems decompressing the install script on any system.

Building the installer from SVN

FUDforum sources can also be obtained from SVN (subversion) should you want to build the scripts yourself (only for experienced users). For example:

Downloading FUDforum from SVN:

svn co https://fudforum.svn.sourceforge.net/svnroot/fudforum/trunk fudforum

Once the files are retrieved, run the following commands to create the install script

cd fudforum
cp install.php install-final.php
chmod 755 create_file_list
./create_file_list install 1 >> install-final.php

Note: You will need to have a php binary installed on your system in order to generate the install-final.php installation script. If you already have a php binary in your system, but it is not inside /usr/local/bin/php, modify the 1st line inside the create_file_list script to reflect the proper path of the php binary on your system.

Note: If you want a smaller install script and have php compiled with the zlib module, you can pass a 2nd argument to the create_file_list script, which would compress the archive data. This will result in a file that is approximately 1/3 the size.

GUI installation

Now that you have the FUDforum installation script, install.php, copy the script into a web browseable directory. It is recommended to copy the script into the web directory where you intend to install the forum. To begin the installation of the forum, use your browser to access the install.php file.

Once you've accessed the script, you will see the 1st step of the installation wizard, which consists of five steps.

Step #1: Path of System Files and Directories

During the 1st step of the FUDforum installation, you get the opportunity to specify where you want the forum's files to be installed, as well as the URL of the forum. The install script will automatically put some default values for the options asked, you can use those values, or you can change them. Important

If your PHP has safe_mode enabled, you'll see an indicator that it is enabled in red on top of the install wizard. If safe_mode is enabled, you CAN NOT use specify the directory where you've placed install.php as Server Root or Forum Data Root.

Server Root

The Server Root option allows you to specify the directory path where the forum's browseable files will be stored on your server's hard-drive. You will need to specify the full path to the directory. For example:

*NIX: /home/user/public_html/forum/
Windows: c:\\web\\my website\\forum\\

You need to enter \\ as directory separator on Windows because normally, \ is interpreted as an escape character. Since PHP is smart enough to convert / to \ internally, on Windows, you may want to use / as the directory separator and save yourself the hassle of having to deal with \\.

Forum Data Root

This is the location on your server's hard-drive where the forum's data files will be stored. It is highly recommended not to keep this directory inside a web browseable directory, since sensitive files such as messages bodies will be stored in it. For example:

*NIX: /home/user/public_html/forum/
Windows: c:\\web\\my website\\forum\\

Securing directory with .htaccess

<Location />
Order Deny,Allow
Deny from all
</Location>

The directories that you have specified as Forum Data Root and Server Root must exist and the webserver must have the permission to write to those directories before you click on the next link on the install wizard.

On *NIX systems there are several ways you can assign proper permissions to the directories you intend to use. The simplest method is to run command chmod 777 /home/user/directory in your shell account.

If you do not not have a shell account you can assign proper permissions to a directory by using your FTP client.

Changing permissions with CuteFTP:

  • Select the directory
  • Press CTRL+SHIFT+A
  • Enter 777 in the manual textbox
  • Press OK

Changing permissions with WS_FTP:

  • Right click on the directory
  • Choose the chmod UNIX option
  • In the dialog that appeared check all the checkboxes
  • Press OK

Forum WWW Root

Enter the URL to your forum. When the forum is installed, visitors will be able to access it by going to this URL. Any files places inside Server Root should be accessible by going to this URL. For example, if you install FUDforum in /dir/html/myform, your WWW_ROOT should be http://server:port/myforum/.

Once you've entered all the values, click on the next link to proceed to step #2 of the installation.

Step #2: Database Settings

Now that the forum's files were successfully decompressed, you will now need to specify the database settings for your forum.

Database Type:

Which database system to use to store the forum's data, MySQL or PostgreSQL.

Database Server:

This is the IP address or a UNIX domain socket that will be used to connect to the database server you intend to use.

Note: For optimal performance, we recommend using UNIX domain sockets.

Example:

Standard IP 127.0.0.1
UNIX Domain Socket :/tmp/mysql.sock

Database Login:

Login name for your database account.

Database Password:

Password for your database account.

Database Name:

The name of the database, where the forum's data will be stored.

FUDforum SQL Table Prefix:

A alphanumeric string that will be prepended to all FUDforum's table names. This is done to prevent conflicts with your existing tables, which may share same names as the tables used by FUDforum. As well as allow you to install multiple forums into a single SQL database by specifying a different prefix.

By default, this option has a value of "fud30_", if you are not sure, leave this value as is.

Step #3: Cookie Domain

Cookies are little bits of information that are stored on the user's computer, which are sent by the browser to the website which set them. Unless otherwise specified, FUDforum uses cookies to track the currently logged in users, thus the user is not required to login every time.

In order for the cookie to be set properly, it needs to have a correct domain specified for which you are sending a cookie. The installation script automatically figures out the most optimal cookie domain based on the URL you've entered in step #1.

If you decide to change this value make sure the domain has no less than two dots (2 x '.') in it, for example:

.mydomain.com

This is necessary because many browsers will not accept a cookie unless the domain has at least 2 dots in it.

Due to the nature of cookies, cookies cannot be set for IP address' or domains without any dot's in them. In this case, the forum will revert to using URL based sessions to keep track of users. The downside of this, is that after certain period of inactivity, usually 30 minutes, the session will expire and the user will be required to re-login.

Step #4: Forum Language

In this step you get to choose the language that your forum will be in, the list of available languages is listed in the select box. This setting is not permanent and if you so desire you will be able to change it later once the forum has been installed.

Step #5: Admin Account

The last step of the installer involves the creation of the first administrator account. You will need to enter the administrator's login name, password and the email address into the specified text boxes. For best security, do not use easily guessable login names like "admin" or "administrator".

You will be able to add additional administrators once the forum is installed.

Installation Complete

The forum installation has now been completed, if you click on the next button you will be taken to a login form that will allow you to login into the administrator account you've created on step #5

It is of critical importance that you remove the install.php file once the installation process has been completed. Otherwise someone could re-install over the forum you have created.

Command line installation

A command line installer is offered for hosts and experienced users who need to perform repeated and/or automated FUDforum installations.

Building the command line installer

The command line installer is not available for download, but can be build from the SVN repository. To start, checkout the following code from the repository:

svn co https://fudforum.svn.sourceforge.net/svnroot/fudforum/trunk fudforum

Once the files are retrieved, run the following commands to create the install-cli-final script:

cd fudforum
chmod 755 create_file_list
cp install-cli.php install-cli-final.php
./create_file_list install 1 >> install-cli-final.php

When done, the install-cli-final.php script can be distributed to the systems were you need to install FUDforum.

Running the command line installer

You can run the command line installer in interactive or automated mode. For automated installation, create file called fud_config.ini with the below settings. If this file is not present, or some setting are missing, the script will interactively prompt for them:

; Settings for command line installer
WWW_ROOT                = "http://127.0.0.1:8080/forum/"
SERVER_ROOT             = "/home/lampstack/apache2/htdocs/forum/"
SERVER_DATA_ROOT        = "/home/lampstack/apache2/htdocs/forum/"
DBHOST                  =
DBHOST_USER             = root
DBHOST_PASSWORD         = dbpassword
DBHOST_DBNAME           = fudforum
DBHOST_TBL_PREFIX       = fud30_
DBHOST_DBTYPE           = mysql
COOKIE_DOMAIN           = 127.0.0.1
# LANGUAGE                = english (FUDforum 3.0.0 and earlier releases)
LANGUAGE                = en
ROOT_LOGIN              = admin
ROOT_PASS               = admin
ADMIN_EMAIL             = "me@myserver.com"

To start the command line installer, run:

php install-cli.php

Also see

  • FAQ, some frequently asked questions w.r.t installing FUDforum.
  • Configuration, configuring your forum after installation.
  • Upgrading, upgrade procedure.
Languages
Personal tools