Login :: Sitemap :: Contacts

 SUMO Homepage > Documentation > Basic configuration
Basic Configuration
Warning for MacOSX users: PHP does not seem to like Mac end of lines character ("\r"). So ensure you choose the option that allows to use the *nix end of line character ("\n") in your text editor before saving a script you have modified.

Almost all configurable data is placed in two files on <sumo_dir>/configs/ directory, are config.server.php and config.databsase.php.
  • config.server.php

    The parameters which relate to server are placed in this file (<sumo_dir>/configs/config.server.php).
    All options are described below:

      This option enable or disable verbose errors to view all possible messages from PHP engine (recommended only on testing environment for security reasons).
    • SUMO_NODES_MANAGEMENT <- No Longer Used

      If you have more than one Sumo server and you want to share same database (to use same informations), you must enable this option setting SUMO_NODES_MANAGEMENT to true (default is false):

      This feature is useful when you run SUMO on multiple servers, but without a system to share user session between servers (a shared filesystem or other clustering solution).
      In fact PHP normally create a special cookie on the browser client where store the session id of the connected user. But this cookie is tied to the http address of the web server that have create it, so, when user change server it must to re-login again.

      To avoid this, SUMO have an internal replicator system that create required cookie for every node that you have created. So, if you want share user session between nodes/servers and users connections come from direcly to your web servers you must enable this option setting SUMO_SESSIONS_REPLICA to true.

      Remember that if all users connections come from a load balancer this feature is not necessary because the user cookie have the address or IP of the load balancer and not a specific web server where SUMO runs.

      Enable this feature if you wish save session informations into database. Not required on standalone Sumo server but highly suggested if you have enabled "sessions replica".
    This is a standard standalone server configuration file:
     * if TRUE display any error, default is FALSE
     * for security reasons
    define ('SUMO_VERBOSE_ERRORS', false);

     * Enable session replica between nodes
     * NOTE: useful if don't have a load balancer.
     * WARNING: Not running with SQLite database.
    define ('SUMO_SESSIONS_REPLICA', false);

     * Store sessions on database
     * NOTE: Not running with SQLite database.
    define ('SUMO_SESSIONS_DATABASE', false);
  • config.database.php

    In this file are placed the parameters to access on your SUMO database server.
    This is an example of database file configuration (for MySQL):
     * See ADODB manual to find supported database
     * http://adodb.sourceforge.net/

    $sumo_db['type'] = 'mysql';
    $sumo_db['host'] = 'localhost';
    $sumo_db['port'] = '3306';
    $sumo_db['name'] = 'sumo';
    $sumo_db['user'] = '...database user...';
    $sumo_db['password'] = '...database password...';
    • $sumo_db['type']

      Sets here your SUMO database type. Currently support MySQL, PostgreSQL and SQLite v.2 databases.
      Default database is MySQL.
      $sumo_db['type'] = 'mysql';
    • $sumo_db['host']

      Contains the hostname (or IP address) of your database server. In a basic configuration SUMO database is on the same server of SUMO console (where PHP run), so you must set 'localhost'. If database server is a remote machine you must set the IP address or the hostname.

      Note: Make sure that a server where run SUMO can connect to this database server.
      If you don't have DNS configured to resolve database address you must remember to set hosts file (on Linux is /etc/hosts) to resolve hostname correctly.
      $sumo_db['host'] = 'localhost';
    • $sumo_db['port']

      Number of port used by your database.
      For example MySQL use port 3306 as default, PostgreSQL use 5432, SQLite work on file (no port needed).

      $sumo_db['port'] = '3306';
    • $sumo_db['name']

      Name of the database (where Sumo tables it has been installed).
      $sumo_db['name'] = 'sumo';
    • $sumo_db['user']

      Login id to connect to database.
      $sumo_db['user'] = '...database user...';
    • $sumo_db['password']

      Password to connect to database.
      $sumo_db['password'] = '...database password...';

      Note: Password is not encrypted because who can view this configuration file can make what it wants! Read Security startup guide for more informations.
  • If you have more than one Sumo server and you want to share same database (to use same informations), you must create a node for your server to enable external connections, click here for details.