Brim - Installation guide

I am very interested in your experiences with Brim.

You can send comments directly to me but preferable you can add them to the PHorum where other can respond to your questions/remarks as well.

Table of contents

Install script.

This installation guide is provided for those who have problems with the provided installation script or simply would like to perform the installation by hand.
If you reached this page in search for information on the installation: there is an installation script (install.php) in the root directory of Brim. Execute this script and brim will install/upgrade.

Prerequisits

Database installation

Read the database specific documentation. A MySQL setup (post-installation) example is provided

Example: Setup a MySQL environment

a. Startup mysql server/daemon
b. Set an admin password

			mysqladmin -u root password 'your-password'

Create a database called 'brim'

The database name can be something else. 

		$ mysql [-u user] [-p]
		mysql > create database brim;
		mysql > quit
or 
		$ mysqladmin [-u user] [-p] create brim

Create the table structure for the application

This step must be repeated for the framework and each of its plugins!!!! If you do not want certain plugins to be installed, delete their directories from the plugins directory or you will encounter errors (brim tries to dynamically load all plugins that are found in the plugin directory and will show errors if those plugins found are not installed) 

		$ mysql brim [-u user] [-p] < 'path.to'/create.xxx.sql

Example

If you are in the root directory of the brim application, you will have to specify the following: 

		$ mysql brim [-u user] [-p] < framework/sql/create.xxx.sql
		$ mysql brim [-u user] [-p] < plugins/bookmarks/sql/create.xxx.sql
		$ mysql brim [-u user] [-p] < plugins/calendar/sql/create.xxx.sql
		etc... (there are more plugins!)

Setup permissions

		grant all rights to user
		$ mysql -u root -p

		mysql> GRANT ALL PRIVILEGES ON brim.* TO 'brim_admin' IDENTIFIED BY 'brim_admin'  WITH GRANT OPTION;

The user 'brim_admin' is the user that connects to the database. This is an arbitrary name, it can be anything. This user must have full rights on the database in which brim is installed however.

Edit the framework/configuration/databaseConfiguration.php file for the correct settings.

Your application will not work otherwise :-)

Setup the admin user

The application has one dedicated user called 'admin'. This is the only user that is able to change application parameters. Install the admin user with an sql statement similar to: 

		INSERT INTO brim_users (loginname, password, name, email, description, when_created, last_login)
			VALUES ('admin', MD5('YOUR_PASSWORD'), 'Admin user', 'your.admin@email.address', 'A small description', NOW(), null);

Check the installation

You should now be able to login using username/password 'admin'. Change the password via the preferences. If you encounter problems you can always contacts me at: contact me at: barry [at] nauta [dot] be or visit the projects website at http://www.brim-project.org/

Please mention

Finishing up

The admin section allows the addition of more users.

Delete the install.php script once installation is succesful!!! You might also want to delete the phpinfo.php file...

Do not forget to change the admin password!!!

Have fun :-)

Trouble shooting

If you have followed the steps and there are still problems, here are some more tips that might help or produce additional output which you can send me for evalutaion :-)