Code Structure 2009-10-17 13:39 GMT

How Troubadour code is structured, and how can you customize it.

Directory structure

Troubadour directory structure on your server should look like this:

tr-custom (previously tr-content)
   languages (translations)
   plugins (custom code - under development)
   themes (customizable themes)
tr-data
   db* (xml-databases)
   media (uploaded media files and images)
   session* (session data for logged in users)
   tmp* (temporary files and backups)
tr-extras (external projects adapted)
tr-includes (essential)
   admin (essential)
   class (essential)
   tpl (essential, theme templates)
tr-install** (delete after installation)

Customizing directories

Writable directories

*) Directories tr-data/db and tr-data/tmp should be protected from opening via web browser. By default that is done by .htaccess file under each directory - ensure that you can't access them from browser!! If you want to protect them even further, move them away from you public directory tree and give their new locations in config.php on your installation root directory, eg. '../../../newdir/db/' relative to the installation root directory. In addition, these directories should be writable (along with tr-data/media). On Linux systems this means that if database writing doesn't work, you should change the permissions for these directories to 777 (default 755 or even 700 works on most systems, but not all).

Remove install directory

**) If everything works fine, to be on the safe side, delete (or rename or move) tr-install directory under the installation root directory.