INSTALL

// Vesuvius 0.9.2 Installation Instructions
==============================================

Prerequisites: Apache 2.2+, MySQL 5+, PHP 5.3+ (configured to use short tags in php.ini)


Currently, Vesuvius lacks an installer, so the installation process is done manually.
Please follow the steps below to instantiate an instance of Vesuvius >>

1) Get the codebase (you have it already, since you're reading this?)

Check out the codebase from launchpad >>
https://code.launchpad.net/vesuvius

(or download a packaged version) from >>
https://launchpad.net/vesuvius/+download

Sahana Vesuvius requires Apache, MySQL, and PHP to function. We will not cover here how
to setup and install Apache, MySQL, or PHP. But, what you will need to do is place the code you
have downloaded to the appropriate place on your filesystem so that the /www/ directory of Sahana
Vesuvius is clearly visible from your web server. On some systems, this would mean placing
the code in /opt, like /opt/vesuvius and pointing your apache server's virtualhost to the
folder /opt/vesuvius/www.


2) Create a configuration file. You can do this by going to /conf and manually copying
the sahana.conf.example file into a new file sahana.conf --- afterwards, edit the settings
of this new file to your liking.



3) Create an .htaccess file in your /www directory. There is an example there in the same
location: .htaccess.example ~ copy it to .htaccess and then begin to modify the file. You
may or may not even need to edit it, depending on where your site is located. Specifically,
refer to these lines:

##### Only use 1 of the following RewriteBase options ~ comment the other out
##### for when Sahana is installed on a virtual host at root level ie. http://domain.com/
RewriteBase /

##### for when Sahana is installed in a user homedir ie. http://domain.gov/~gmiernicki/vesuvius/vesuvius/www/
#RewriteBase /~miernickig/vesuvius/vesuvius/www/

If your site is running on the root path of a domain, you will not have to change anything.
You are good to go with the default example file. Else, your site is running on a non-root
path, comment out the first RewriteBase line, uncomment out the second one, and then update
its path to the path of your installation.



4) Create a new MySQL Database on your server. Assign a new user to the database. Edit
the sahana.conf file from the step 2 with the new database's settings.



5) Import an initial database. You can do this in a number of tools, for example:
PHPMyAdmin, MySQL Admin, or from a shell with the mysql command. The default database to
use in the file /backups/vesuviusStarterDb_v092.sql



6) Create a folder /www/tmp (this is the cache folder Sahana uses for many things) and
appropriately change the permissions of the file so it is writable by the web server.
This can be done by executing the commands below:

cd www ;
mkdir tmp ;
chmod 777 tmp ;

(the above may be unnecesary as the packaged version of Vesuvius v0.9.2 has these folders packaged)



7) *OPTIONAL* If you wish to use the snapshot module for database backups and restores, then you
must also update the permissions on the /backups folder:

chmod 777 backups ;



8) If you did everything above correctly, you should be able to navigate to the site
and login >>

username: root
password: Vesuvius2012

After logging in, its adviseable to go to My Settings and then the Change My Password tab
to alter the default password and add a bit of security to your site!!


9) Make the cache folder for the htmlPurifier writable:
chmod -R 777 3rd/htmlpurifier/library/HTMLPurifier/DefinitionCache

This final step allows your instance to be able to download a fresh purifier definition and cache it locally.



10) Enjoy Vesuvius!


--Sahana Vesuvius Team