Manual Installation Instructions

The following is a step-by-step guide to installing Omnium® Open Software on your server:

  1. Ensure you have all the system requirements setup

  2. Download the  latest release of Omnium Open Software from the start page OR to obtain the source code via  Subversion:
    # svn checkout http://svn.omnium.net.au/omnium-4/trunk
    
  3. Unarchive this file into the root folder of your web server. This location is detailed in the  DocumentRoot directive of Apache's main configuration file httpd.conf. You will see that there are two folders, codebase and example-site present in the archive, the latter of which will contain the files specific to each project you setup so rename this to something of your choice. The directory structure should now be as follows:
    /htdocs/
           /codebase/
           /your-project/
                        /custom
    
  4. Create symbolic links to the codebase files. From within your project folder, create the symbolic links for all the items from the codebase directory using the:  ln command (Linux) or the  mklink command (Windows Vista)
    Linux
    
    # ln -sf ../codebase/administration
    # ln -sf ../codebase/base
    # ln -sf ../codebase/includes
    # ln -sf ../codebase/index.php
    # ln -sf ../codebase/layout
    # ln -sf ../codebase/modules_default
    # ln -sf ../codebase/widgets
    
    Windows (Vista command line)
    
    > mklink /d ../administration ../codebase/administration
    > mklink /d ../base ../codebase/base
    > mklink /d ../includes ../codebase/includes
    > mklink ../index.php ../codebase/index.php
    > mklink /d ../layout ../codebase/layout
    > mklink /d ../modules_default ../codebase/modules_default
    > mklink /d ../widgets ../codebase/widgets
    
    Note that index.php does not require the '/d' switch, as it is not a directory. Mklink will default to a file if no switch is added.

  5. Once this is done, the contents of your the folder should look this when you list the directory from the command line:
    Linux
    
    # ls -la
    
    drwxr-xr-x   12 www   admin  408 Jan  1 12:00 .
    drwxr-xr-x   10 root  admin  340 Jan  1 12:00 ..
    lrwxr-xr-x    1 root  admin   26 Jan  1 12:00 administration -> ../codebase/administration
    lrwxr-xr-x    1 root  admin   16 Jan  1 12:00 base -> ../codebase/base
    drwxr-xr-x    7 www   admin  238 Jan  1 12:00 custom
    lrwxr-xr-x    1 root  admin   20 Jan  1 12:00 includes -> ../codebase/includes
    lrwxr-xr-x    1 root  admin   21 Jan  1 12:00 index.php -> ../codebase/index.php
    lrwxr-xr-x    1 root  admin   18 Jan  1 12:00 layout -> ../codebase/layout
    lrwxr-xr-x    1 root  admin   27 Jan  1 12:00 modules_default -> ../codebase/modules_default
    lrwxr-xr-x    1 root  admin   19 Jan  1 12:00 widgets -> ../codebase/widgets
    
    Windows (Vista command line)
    
    > dir
    
    17/10/2007  12:00 PM    <DIR>          .
    17/10/2007  12:00 PM    <DIR>          ..
    17/10/2007  12:00 PM    <SYMLINKD>     administration [..\codebase\administration\]
    17/10/2007  12:00 PM    <SYMLINKD>     base [..\codebase\base\]
    17/10/2007  12:00 PM    <DIR>          custom
    17/10/2007  12:00 PM    <SYMLINKD>     includes [..\codebase\includes\]
    17/10/2007  12:00 PM    <SYMLINK>      index.php [..\codebase\index.php]
    17/10/2007  12:00 PM    <SYMLINKD>     layout [..\codebase\layout\]
    17/10/2007  12:00 PM    <SYMLINKD>     modules_default [..\codebase\modules_default\]
    17/10/2007  12:00 PM    <SYMLINKD>     widgets [..\codebase\widgets\]
    
  6. Set the permissions and ownership settings on your project files. Where <apache-user> is the user that apache is running under (only the directory creation is required on a Windows Install).
    Linux
    
    # chmod -R 755 your-project/custom/graphics
    # chown -R <apache-user> your-project/custom/graphics
    # mkdir -m 0755 your-project/modules
    # chown <apache-user> your-project/modules
    
    Windows (Vista command line)
    
    > mkdir your-project/modules
    
  7. Create the database to be used by your Omnium Open Software interface.

  8. Edit the database settings for your project via the dataobject.config.php file in your-project/custom/config with the details used when creating the database.
    $dataobject['dbdsn']['username'] = 'your_username';
    $dataobject['dbdsn']['password'] = 'your_password';
    $dataobject['dbdsn']['database'] = 'your_database';
    
  9. Include the paths to the relevant external applications (for example, ImageMagick / Gifsicle) via the omnium.ini file located in codebase/includes/config
    Linux
    
    [programs]
    mogrify   = "/opt/local/bin/mogrify"
    convert   = "/opt/local/bin/convert"
    composite = "/opt/local/bin/composite"
    identify  = "/opt/local/bin/identify"
    gifsicle  = "/opt/local/bin/gifsicle"
    
    On a Windows Vista install, only the application needs to be specified if the applications are installed in your system path.
    Windows Vista
    
    [programs]
    mogrify   = "mogrify.exe"
    convert   = "convert.exe"
    composite = "composite.exe"
    identify  = "identify.exe"
    gifsicle  = "gifsicle.exe"
    
  10. Make the following changes to your local PHP and MySQL configuration files
    • In php.ini: The upload_max_filesize and post_max_size values need to be equal to or greater than the maxfilesize value in omnium.ini which is initially set to 20 megabytes. The post_max_size should be approximately 10 megabytes greater than the maxfilesize, to allow for overflow in Omnium's file upload method. An update to the setting for incoming cookie data is also required.
      ; Maximum allowed size for uploaded files.
      upload_max_filesize = 20M
      
      ; Maximum size of POST data that PHP will accept.
      post_max_size = 30M
      
      ; Magic quotes for incoming GET/POST/Cookie data.
      magic_quotes_gpc = Off
      
    • A similar update to my.cnf, the MySQL configuration file, is also needed but the name and location of the file may vary depending on the version and OS you are running. For the details specific to your system, we recommend checking the  MySQL documentation. Under the variables for the mysqld program, edit the max_allowed_packet to be 21M
      max_allowed_packet = 21M
      
      You will need to restart Apache and MySQL in order for these setting to take effect.

  11. Customize your project environment via the language file located in your-project/custom/libraries. By adding entries into this file, you can override the default naming supplied with your project to make it your own. An example set of entries is being used in the default configuration for your project to help you get started. The interface can also be customized via the Admin tool available by clicking the tab in the top-right menu.

  12. Login to you interface using the default administration account

Return to the main page