Installing SimpleSite

This installation guide is directed toward developers as this project is in its early phases.

I. Pre-Requisites * PHP 5+ - ZipArchive - MySQL Access * MySQL - One Database * HTTP Server - PHP Capabilities

II. Installation 1. Copy SimpleSite to the path the server will access it from. 2. Update $configs["path"]["root"] (if necessary) * Assuming the DOCUMENT_ROOT is /var/www/, and SimpleSite was in /var/www/SimpleSite_v1.1/, you should set this as /SimpleSite_v1.1/. 4. Update $configs["database"]["host"] to the hostname the MySQL server is at. 5. Update $configs["database"]["username"] to the MySQL username. 6. Update $configs["database"]["password"] to the MySQL password. 7. Update $configs["database"]["database"] to the MySQL database to connect to. 8. Update $configs["database"]["tbl_prefix"] to the prefix you want to use for MySQL tables. 9. Log into AdminCP (at http://site.name/configs/path/root/?mod=adminCP and go to the environment tester. * If any errors arise it will involve the database, any error in "path" will result in you being unable to view the site. 10. It is recommended that you create a table SS_constants (where SS_ is the tbl_prefix) which will allow you to add constants without having to update the configuration file. * You can do so by going to the database admin (from AdminCP) and executing a CREATE TABLE query.

III. Configuration File * Display Options * $configs["default_theme"] * Default theme to use (theBasics by default) * $configs["default_mod"] * Default module to use (blank loads index.template as {CONTENT}) * Document paths * $configs["path"]["root"] * The path from the http DOCUMENT_ROOT to SimpleSite * $configs["path"]["themes"] * The path to the folder containing all themes * $configs["path"]["templates"] * The path to the current theme's templates (recommended to leave as is) * $configs["path"]["mod_templates"] * The path to mod_templates (starts with $_SERVER['DOCUMENT_ROOT'].$configs['path']['root'] automatically - don't write it) * $configs["path"]["tmpdir"] * The temporary directory to use (/tmp/ by default) * Database * $configs["database"]["host"] * The hostname to connect to for MySQL * $configs["database"]["username"] * The username to use for MySQL login * $configs["database"]["password"] * The password to use for MySQL login * $configs["database"]["database"] * The database to use * $configs["database"]["tbl_prefix"] * The prefix to add to table names (for using a shared database)

IV. Introduction to the Admin Control Panel * Backups * Creating Backups 1. Select the type of backup using the dropdown box * All - Every file from the SimpleSite root * Back-End - Only files necessary for the back-end (no mods or templates) * Database - Only information stored in the database * Modules - Only modules and module templates * Templates - Module and theme templates 2. Press "Backup!" button * Downloading Backups 1. Select the appropriate backup from the list and it will start to download * Deleting Backups 1. Press the "Delete Backups" button (note: all backups will be deleted) * Configurations * Caution: Making the wrong changes to the configuration file could result in the website being unable to function. * Database Admin * Choosing a Database * New Entries * Updating/Deleting Entries * Custom Queries * IP Blocking * Adding Entries 1. Type IP/Hostname in the text box 2. Press the "Add" button * Deleting Entries 1. Check the box next to each entry you wish to delete 2. Press the "Delete" button * Module Admin * Uploading Modules 1. Select the .zip file to upload 2. Press the "Upload" button * Enabling/Disabling Modules 1. Press the "Yes"/"No" link next to the module you wish to enable/disable * Template Admin * Creating New Templates 1. Select the type of template from the dropdown box 2. Type in the filename to save the template as in the textbox 3. Press the "New" button * Uploading New Templates 1. Select the type of template from the dropdown box 2. Select the .template file to upload 3. Press the "Upload" button * Updating/Deleting Templates 1. Select the file you wish to update/delete from the dropdown box 2. Make any changes desired 3. Press the "Save" button to update the file 4. Press the "Delete" button to delete the file * Theme Manager * Selecting Theme 1. Choose the desired theme from the dropdown box 2. Press the "Set Theme" button * Uploading Theme 1. Choose the deisred .zip file to upload 2. Press the "Upload Theme" button * Test Environment * Normal Output - No dependency or file permission errors, everything should work fine. * Possible Errors 1. Templates directory does not exist. How are you seeing this? * While you should theoretically not be able to see the admin panel without the templates directory existing, if by some strange chance you do, you should create the directory you specified in $configs["path"]["templates"]. 2. Modules directory does not exist, therefore no mods will be used. * This should also break the admin panel, however if it doesn't, you should create the includes/mods/ directory. 3. Configuration file does not exist. * This should break the site in general, however if it dosn't, you should create includes/config.inc.php 4. MySQL credentials are incorrect. * You should alter the database host/username/password in the config file 5. ZipArchive is not installed, you will not be able to upload themes or modules. * You should install the ZipArchive PHP extension. 6. Config file is not writable, you will not be able to edit it from the admin control panel. * Under Linux you should execute chmod 755 includes/config.inc.php 7. Theme directory is not writable, you will not be able to upload new themes. * You should execute chmod -R 755 your/theme/directory/path 8. Module templates directory is not writable, any modules you upload will not have the required templates. * You should execute chmod -R 755 your/mod/templates/path 9. Custom templates directory is not writable, you will not be able to upload any files there. * You should execute chmod 755 your/custom/templates/path10. Modules directory is not writable, you will not be able to upload any modules. * You should executechmod -R 755 includes/mods/` * Widget Admin * Uploading a Widget 1. Select the .widget.php file you wish to upload 2. Press the "Upload" button * Deleting a Widget 1. Check the box next to each widget you wish to delete 2. Press the "Delete" button

V. Adding On Follow the guides that came along with this file to develop either modules, themes, or widgets. Once one is developed, you zip it up and save it ensuring proper file naming conventions for whichever type of component it is.