OPDB INSTALL INSTRUCTIONS

Server Environment

Apache, version# - 1.3 or higher
(To know the apache version the command-line option is : httpd -v)
(You can learn more about installing apache from :
http://httpd.apache.org/docs/1.3/install.html)

PHP, version# - PHP 5 or higher
(To know the PHP version the command-line option is : php -version)
(You can see a detailed description about PHP installtaion from -
http://in2.php.net/manual/en/install.php)

MYSQL, version# - MySql 5 or higher
(To know the PHP version the command-line option is : mysql)
(You can see a detailed description about MySQL installtaion from -
http://dev.mysql.com/doc/refman/5.0/en/installing.html)

PHP-GDlib, version# - 5.0 or higher(2.0.28 compatible) (There is bundled GD coming with PHP 5 and higher)
(To know the PHP-GD version the command-line option for Linux is : rpm -q php-gd,
Another commandline option is : gdlib-config --version)
(You can also find out the version of PHP-GD by running the phpinfo file. The creation of phpinfo file is described in -
http://www.wallpaperama.com/forums/whats-is-phpinfo-php-file-how-to-create-see-php-configuration-t21.html)
(You can see a detailed description about PHP gd installation from -
http://www.libgd.org/ or http://in2.php.net/gd)

Freetype, version# - 2.3.5
(To know the freetype version installed the command-line option is : freetype-config --ftversion)
(You can see more about freetype installation from -
http://www.freetype.org/)

phpMyAdmin, version# - 2.10.2 or higher
(You can find the phpMyAdmin version from the index page of phpMyAdmin in your system.)
(You can find more about phpMyAdmin installation from -
http://www.phpmyadmin.net/home_page/)

cron jobs - (none required yet)

email features (so OPDB can send emails for account confirmation) -
(You can use any of the email servers like 'EXIM', 'SendMail' etc for enabling email support.
If a mail server is already running then it will be listening at port 25 which is the mail sending port.

Use the commandline option : telnet localhost 25

You will get the name of your mail server as the result of this command if one exists.)
(You can find the list of the commonly used mail servers from :
http://en.wikipedia.org/wiki/List_of_mail_servers)

Download OPDB source files:

OPDB source files are available through subversion. The subversion address is

http://opdb.googlecode.com/svn/code/opdb1.3/

You must either download the sources to your webserving directory or move the contents
to your webserving directory after download.

Configure MYSQL for OPDB

You need to setup the mysql database for OPDB.

  1. Get the OPDB database structure from <OPDB install dir>/sample_database/. The database structure is contained in a text file in this directory. The database structure is a series of SQL instructions that need to be executed to set up the database tables for OPDB.
  2. Restore the database into your MySQL.
    (You can either use PHPMyAdmin to restore the database or you can perform it through the mysql command line.)
    (You can find more about using PHPMyAdmin at :
    www.phpmyadmin.net/home_page/docs.php)
  3. Now create an OPDB user in MySQL with full privileges on the OPDB database. You can use PHPMyAdmin or you can do it through MySQL commandline).
  4. Test the newly created user by trying to connect to the OPDB database using the newly created username/password or by trying to login to PHPMyAdmin using the newly created username/password. If you are able to login then the user creation is successful.
Existing users of a previous version of OPDB, please note: You can upgrade your mysql database to OPDB1.3 by going into the link <OPDB install dir>/admin/    You will find further database upgrade instructions there!!

Configure OPDB

We have certain configuration files which are required for OPDB configuration. The settings in these files will be different for different Operating Systems. So we are providing only templates of these configuration files. These template files are of the format config_%.php.tpl (config_login.php.tpl, config_visual.php.tpl, config_system.php.tpl, config_publish.php.tpl). Please create a copy of these template files in the same folder(<OPDB install dir>/includes/) and rename them as config_%.php (config_login.php, config_visual.php, config_system.php, config_publish.php).

  1. Login scheme configuration
    We are offering two login authentication schemes now -
    1. Internal(MySQL) authentication and
    2. LDAP
    The settings related to login schemes are to be configured in config_login.php.
    You can find the detailed documentation on login/account configuration at
    <OPDB Install dir>/docs/loginmodules.html.

  2. Visual customization
    Another feature offered by OPDB is that you can customize the appearance of your OPDB version.
    You can change the main logo and color themes of your OPDB installation.The settings
    for the visual customization are stored in the file <OPDB install dir>/includes/config_visual.php.

    OPDB comes with five different skins:
    1. Cobolt - (Check <OPDB install dir>/docs/skins/Cobolt.jpg)
    2. Pea Soup - (Check <OPDB install dir>/docs/skins/Peasoup.jpg)
    3. Midnight - (Check <OPDB install dir>/docs/skins/Midnight.jpg)
    4. Steel - (Check <OPDB install dir>/docs/skins/Steel.jpg)
    5. Original blue- (Check <OPDB install dir>/docs/skins/Originalblue.jpg)

    You can switch the skins by uncommenting the respective skin section in config_visual.php.

    To change the Main Logo :-
    Assign the new file path of logo to $MAIN_LOGO.

    To change the Background shade :-
    Assign the new background color to $BACKGROUND_SHADE.

    To change the color of Login Box in Index page :-
    Assign the new color to $LOGIN_BOX

    To change the copyright text :-
    Edit the values of $COPYRIGHT_TEXT1, $COPYRIGHT_TEXT2, $COPYRIGHT_TEXT3 and $COPYRIGHT_TEXT4.

    You can also customize the header section by changing the color values of :-
    $HEADER_BGCOLOR, $HEADER_INFO, $HEADER_FOREGND.

    You can also apply different skins to your OPDB installation
    Please refer <OPDB install dir>/docs/Skinsnapshots.doc for help on different skins and how to apply them.

  3. Client to Host Syncing
    Another feature offered by OPDB is that you can publish the cubes from your OPDB installation to other target installations.
    The settings for the client to host syncing is stored in the file <OPDB install dir>/includes/config_publish.php.

    Please refer <OPDB install dir>/docs/Client2HostSyncConfiguration.html for help on Client to Host Syncing configuration.

  4. Create admin users
    For creating an admin user-
    1. Use the internal login authentication module (The instructions are provided in Login scheme configuration section above) and use the "Get Account" link to create an new user.
    2. Now take the phpMyAdmin and login into it using your mysql user name and password.
    3. Change the database to your opdb database. You will be seeing the tables in your database.
    4. Browse through the table cubes_people, You will be seeing the newly registered whom you want to make an admin.
    5. Take the record into edit mode by clicking on the edit(pencil) symbol. Now change the user_type attribute to admin.
    6. Select the "Save" option from the dropdown at the bottom of the page and click on the Go button.
    Now you have successfully created an admin user.

  5. Setting directory permissions and File upload configurations
    OPDB is providing facilities to upload images, videos etc along with your project documentation.So we need to give proper directory permissions for the upload directories. You have to give read, write and execute permission for the following directories:
    1. <OPDB install dir>/cubeImages
    2. <OPDB install dir>/cubeImages/photothumbs
    3. <OPDB install dir>/cubeImages/thumbs
    4. <OPDB install dir>/cubeImages/temp
    5. <OPDB install dir>/downloads
    6. <OPDB install dir>/weblogImages
         For changing the folder permissions, you can use the following command.
              chmod -R 777 <folder name>
         The upload file size is dependant on the php.ini settings. You can change the upload size by changing the php.ini variable 'upload_max_filesize'. By default it is 2M. (Note: php.ini file can be generally found at /etc/php.ini.) You have to assign a max file size value in bytes to the variable $MAX_FILE_SIZE in config.php

    Existing users of a previous version of OPDB, please note: You have to copy the existing contents in <OPDB install dir>/cubeImages, <OPDB install dir>/cubeImages/thumbs, <OPDB install dir>/cubeImages/temp, <OPDB install dir>/downloads and <OPDB install dir>/weblogImages manually to their corresponding new folders.

Test your installation

QA checklist.
The QA checklist for OPDB installation is provided at
<OPDB install dir>/docs/TestingInventionDB.xls
Please test and verify each of the sections provided in the Check List.

Checking login/user account scheme.
The instructions for testing login/user account scheme is provided at
<OPDB install dir>/docs/loginmodules.html