Support/SUMO install process

This document explains how to install a fresh checkout of SUMO on your server.

Note: Currently SUMO only works well if set up at the root of the domain. You may experience layout or links issues if your setup is different.

Note2: The instructions below have not been tested on a Windows machine.

Requirements

• An up-to-date version of LAMP/MAMP/WAMP stack
  • PHP 5+ preferred, but PHP 4 may do (untested)
• php-memcache and memcached for Memcache use (can be enabled from the admin->features panel)
• Sphinx search engine installed for SUMO tiki-newsearch.php (preferred to older search). See Support/Sphinx_Installation

Check out SUMO

Start with a fresh checkout of trunk or our production branch

• trunk
• production

Note: using the trunk checkout below

svn co https://svn.mozilla.org/vc/projects/sumo/trunk/ sumo

Configuration files and scripts

Now create the required configuration files:

cd sumo

To enable sphinx search:

cp scripts/sphinx/search.conf.php.dist scripts/sphinx/search.conf.php

To enable showfor: (without this, knowledge base pages may show up blank)

cp scripts/showfor/config.php.dist scripts/showfor/config.php

To enable minify: (without this, pages may show up without CSS and JS)

cp scripts/minify/minify.conf.php.dist scripts/minify/minify.conf.php
touch webroot/files/minify.conf

On *nix based systems, you must allow permissions for the server scripts (often apache/www-data user) to write to minify.conf For example:

sudo chmod 775 webroot/files/minify.conf

Here you must configure the databsase user, host, pass, etc. To set up the database connection:

cp webroot/db/local.php.dist webroot/db/local.php
vim webroot/db/local.php

$host_tiki='localhost'; // change this to your host
$user_tiki='mysqluser'; // change this to your db user
$pass_tiki='mysqluserpw'; // change this to your db password
$dbs_tiki='mysqldbname'; // change this to your db name

Now create the templates directory for Smarty:

cd webroot
./setup.sh

Depending on your permissions, the output of setup.sh will explain which specific command you need to run.

Finally, to set up URL rewrites: (in ./webroot)

./htaccess.sh

To log in as an admin, you may use the user/pass: admin/admin on a clean schema. If you're using a dump, you can change the `password` column to 'admin' in the users_users table for the user 'admin' and then log in.

All-in-one code

svn co https://svn.mozilla.org/vc/projects/sumo/trunk/ sumo
cd sumo

# To enable sphinx search:
cp scripts/sphinx/search.conf.php.dist scripts/sphinx/search.conf.php

# To enable showfor: (without this, knowledge base pages may show up blank)
cp scripts/showfor/config.php.dist scripts/showfor/config.php

# To enable minify: (without this, pages may show up without CSS and JS)
cp scripts/minify/minify.conf.php.dist scripts/minify/minify.conf.php
touch webroot/files/minify.conf

# On *nix based systems, you must allow permissions for the server scripts (often apache/www-data user) to write to minify.conf

# For example:
sudo chmod 775 webroot/files/minify.conf

# Here you must configure the databsase user, host, pass, etc. To set up the database connection:
# cp webroot/db/local.php.dist webroot/db/local.php
vim webroot/db/local.php

# Now create the templates directory for Smarty:
# Depending on your permissions, the output of <code>setup.sh</code> will explain which specific command you need to run.
cd webroot
./setup.sh

# Finally, to set up URL rewrites, in ./webroot
./htaccess.sh

Database setup

We set up a clean schema in bug 502089.

• To use Sphinx search, enable it at tiki-admin.php?page=features
• To use Memcache, enable it at tiki-admin.php?page=features
• To use Minify, enable it at tiki-admin.php?page=general

More information

If you would like more information, you can contact the SUMOdev team at sumo-dev@mozilla.com