Location: PHPKode > projects > Illumicore > illumicore/Illumicore Guide.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  <meta http-equiv="Content-Style-Type" content="text/css">
  <meta name="Generator" content="Cocoa HTML Writer">
  <meta name="CocoaVersion" content="824.41">
  <style type="text/css">
    p.p1 {margin: 0.0px 0.0px 16.0px 0.0px; font: 24.0px Arial}
    p.p2 {margin: 0.0px 0.0px 13.0px 0.0px; font: 13.3px Arial}
    p.p3 {margin: 0.0px 0.0px 14.0px 0.0px; font: 18.0px Arial}
    p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial}
    p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 11.9px Courier}
    span.s1 {font: 10.8px Courier}
<p class="p1"><b>Introduction and Installation Guide</b></p>
<p class="p2">For the latest version of this document see http://code.google.com/p/illumicore/wiki/InstallationGuide</p>
<p class="p2">Illumicore was designed from the beginning for use on church web sites. The features are set for that, and so is the UI. The installation is rather straightforward. Illumicore does not use MySQL or any other database server but uses SQLite, a flat file SQL database integrated with PHP5.</p>
<p class="p3"><b>Installation Requirements</b></p>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial">PHP 5.1.4 <i>(5.2.1 recommended)</i></li>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial">Web server compatible with .htaccess and mod_rewrite <i>(Apache + modrewrite recommended)</i></li>
<p class="p2">If you are not sure you meet those requirements, contact your server administrator. Or if Illumicore simply won't work, that could be another sign.</p>
<p class="p3"><b>Installation - Step 1 - Copy files to Server</b></p>
<p class="p2">The first step is obviously to download the latest Illumicore release from the downloads page. Once downloaded, extract the archive so that you have a folder named <b>www</b>.</p>
<p class="p2">You must then copy the contents of www to your web server's document root, the main folder where your web content is contained.</p>
<p class="p2">You must create a new folder named data in the document root. You must then set the server permissions (chmod) for the data folder to 0777. This can be done by most FTP clients either in a special permissions window or the folder/file information window. Just make sure that "anybody" can read|write|execute.</p>
<p class="p2"><b><i>(NOTE: NOT AVAILABLE FOR 0.1)</i></b><i> For security reasons you may place the data folder under the document root and point to it's location in configuration.xml using the "data_location" config in core.</i></p>
<p class="p3"><b>Installation - Step 2 - Configuration</b></p>
<p class="p2">The second and final step is to configure Illumicore.</p>
<p class="p2">The most important thing to note, is that all web administration function are accessed from /admin. So if you have Illumicore installed at www.mychurch.tld, you would access the administration pages as www.mychurch.tld/admin/</p>
<p class="p2">When you first go to the admin page you'll be able to login without an email address and password. Or in other words, your installation will be initially extremely insecure! So I strongly urge you to go to the "<b>Users Manager</b>" and <b>immediately Create a User</b>!</p>
<p class="p2">Once you're done there, you'll probably want to open configuration.xml in a plain text editor and change certain strings such as the web site title, sub title, and welcome text.</p>
<p class="p2">For a complete documentation of configuration.xml see below.</p>
<p class="p3"><b>Installation - Finished!</b></p>
<p class="p2">I hope it went well for you!</p>
<p class="p2"><b>If you find any issues, place report them in the Issues tab. We'll all appreciate it! </b>For further support, email hide@address.com</p>
<p class="p1"><b>configuration.xml</b></p>
<p class="p2">Inside this file called configuration.xml, is where many web site specific options are specified such as the web site title, organization address for maps, and the username for accessing the events calendar.</p>
<p class="p3"><b>Core</b></p>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>document_root</b> - <i>Currently Unsupported.</i></li>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>domain</b> - Your web site domain such as <span class="s1">http://www.mychurch.org</span></li>
<p class="p3"><b>Preferences (prefs)</b></p>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>site_title</b> - The name displayed on every page.</li>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>subtitle</b> - The text displayed right under site_title in small text.</li>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>welcome_text</b> - The welcome text that is displayed on the home page.</li>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>podcast_summary</b> - Summary for your audio podcast.</li>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>webmaster_email</b> - All emails sent by the web site will come from this email address.</li>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>calendar_feed</b> - The HTML address to access your Google Calendar.</li>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>gcal_username</b> - <i>Current Unsupported.</i></li>
<p class="p3"><b>Map</b></p>
  <li style="margin: 0.0px 0.0px 0.0px 0.0px; font: 13.3px Arial"><b>url</b> - The url the map image points to.</li>
<p class="p2"><i>This section will be completed in Illumicore 0.2</i></p>
<p class="p3"><b>Menu</b></p>
<p class="p4">This section defines the menu items under "More Pages". For example if you want to add a link to the page you created on your churches missionaries with the url ID of missions, you would do the following:</p>
<p class="p5"><span class="Apple-converted-space"> </span>&lt;missions&gt;</p>
<p class="p5"><span class="Apple-converted-space">  </span>&lt;title&gt;Missionaries&lt;/title&gt;</p>
<p class="p5"><span class="Apple-converted-space"> </span>&lt;/missions&gt;</p>
Return current item: Illumicore