FrameBeurk documentation

You need to have at your disposal a http server with a PHP 5 active module and a mysql server, for example by a web provider, or on your local computer (like with WAMP on Windows and LAMP on Linux).

If you use WAMP, to prevent the mysql server to turn the table names into lower-case at their creation, edit file my.ini, set parameter « lower_case_table_names=2 », save the file and make a stop/start of the mysql service.

Hypothesis : The URI of your site using FrameBeurk will be « http://localhost:80/Fmbk/ » (on a local server) and the name of the database will be Fmbk.

• Create subfolder /Fmbk in the folder /www.
• Unzip the .zip archive of FrameBeurk into it.
• On the mysql server (interface phpmyadmin) :
• Create database Fmbk,
• In this database, execute all the scripts embedded in folders « /modules/*/_sql/*.sql », beginning with module Beurk, then Uzers.
• Edit file /modules/bootstrap.php and modify it if needed :
• The chosen DB layer (mysql_layer.php or mysqli_layer.php)
• $TRANSAC['Db'][‘Fmbk’] : The connection parameters to the DB.
• Edit file /modules/config.php and modify the items of array $CONFIG['Params'] :
• 'DomaineUrl' and 'UrlSite' : According to your installation
• Replace « Xxx Xxxx » by your name or pseudo
• 'DomaineMail' : Must be the domain name of the out-going email server parameterized on your server.

Be carefull : By default, WAMP/LAMP uses port 80, which is also used by Skype. If you wish to use both, switch Apache to port 8080 and modify the configuration file of the framework in accordance.

8.1. First steps

The installation of the framework being achieved, mysql and http servers running, open an internet browser and connect to your website. At this time, to have a first overview of the functioning of FrameBeurk from the user's point of view, you would probably like to :

8.1.1 Log as administrator

(user=admin, password=admin)

• At the top of the side menu, enter the user code and password, and click on Connexion.
• It is recommended to change the default password of admin.

8.1.2 Create your own account

2 cases :

1. If you are logged in with administrator rights :
• In the side menu, click on « Users » (labels may be not translated yet in the archive you downloaded).
• The list of users is displayed. At the time, it should only contain admin and anonymous.
• At the bottom right of the page, click on « Create a user... ».
2. If you are not logged in :
• At the top of the side menu, click on « Register ».

Be carefull during the creation of your account. Memorise your password and make no mistake in your e-mail address because the framework will send you a message there.

You will not be able to login to your new account until you click on the activation link in the body of the e-mail sent to you.

8.1.3 Set the administrator rights to your account

• Login with the user admin
• Display the list of users, click on yours
• The list of groups associated to your user appears empty. Click on « Associate to a group... »
• Select the group « ADMIN » and click on « OK ».

To check, logoff et reconnect with your personal user. The links « Users », « Groups », « Permissions », « Moderate » should be displayed in the side menu.

8.1.4 Add a welcome message in the News

It needs to be logged in with administrator rights (a rule of the simple Rhum forum).

• In the side menu, click on « News »
• The list of news appears empty. Click on « Add a comment... »
• An input form is displayed in which you can enter your message.
• You can insert BBcodes in the textbox « Data » : Select the text you wish to emphasise and click on the chosen option in the drop-down lists just above the data field.
• Button « Preview » shows you how your message will be displayed, without validation.

8.1.5 Create a section in the forum

• In the side menu, click on « Forum »
• The list of sections appears empty. Click on « Create a section... »
• Fill the informations you wish in the form that is displayed.

When you have created several sections, you can manage their sequence order by clicking on buttons « Up » and « Down » of each section.

8.1.6 Remarks on the field « Import »

• This one appears on creation or update forms of sections, subjects and comments, when the user logged in is administrator (i.e. member of group « ADMIN »).
• Admin users can fill in the name of a .php file present on the server –path relative to subfolder /imports/ of the installation folder.
• This file will be included when displaying single Vues of the entity it is associated too. (not Vues where the entity appears in a list).

The input of an import file is only possible for an administrator, but the display will be made for all.