Jomres Standalone

From Jomres v4 manual

Jump to: navigation, search

Jomres Standalone (AKA Jomres SA)

Contents

Introduction

What is Jomres Standalone

Jomres Standalone is a set of scripts designed to replace the need for Jomres to run inside of Joomla.

When will it be released?

We are intending to release it in a test form as part of Jomres v4.2beta2, sometime in late September 2009. The SA scripts are part of a normal Jomres download, there aren't two different versions of the files, it's all in Jomres Developer.

Tell me more

Ever since it's first inception Jomres has always worked inside of a CMS, using the CMS as a framework to hang it's own functionality off. First there was Mambo, then Joomla (then for a while it was Mambo again, but we'll not go into that).

Over the last couple of years though Jomres has gradually been evolving to not rely on an external CMS's framework for many of it's libraries like capcha, email etc. This allows us to extend it's usefullness across from Joomla to other CMSs. A natural extension of this evolution then is for Jomres to have it's own framework, which is what Jomres SA is*.

  • Actually, to be precise, it's SA that uses Jomres' framework, but that'd be splitting hairs to anybody but a developer.

Why do I need it?

You might not need it, it depends on your requirements. Jomres Standalone is designed to allow the Jomres Site Administrator to run Jomres without the bulk of a Content Management System chewing up precious memory and CPU cycles. It is designed to handle user authentication and basic page layout without any of the other bells and whistles that a CMS provides. If you're not an experienced web designer then you might find that SA is either too simplistic for your needs, or requires too much customising to achieve what you want, because it's designed to be very simple. If you need to integrate Jomres into a CMS then I recommend that you install it inside Joomla instead.

What it is

A small, light set of functions and classes that provide the only thing that Jomres on it's own doesn't have : user authentication and registration.

What it is not

A Content Management System. As stated elsewhere, it's designed to be light so there's no functionality for creating extra pages, modules or anything else like that. If you want to change the page's layout you'll need to physically edit the index.html files in the jomressa/templates folders.

Intended readership/users

Jomres SA is a simplified wrapper for Jomres therefore it doesn't have lots of features for editing settings programatically. Instead it's expected to be used by experienced web developers who are familiar with the mechanics of editing files via ftp/ssh. If you're not familiar or comfortable with doing this, please install Jomres onto Joomla.

Installation

We're going to assume that you have no experience of installing Jomres, so you're unfamiliar with how it's normally installed, and we'll do this step by step. For the sake of this example your site is "http://www.mysite/com".

Before going through the steps to perform an installation we need to point out that a default administrator user is created on installation. This user's login is "administrator" and their password is "welcome". We strongly advise you to change the password once you have installed Jomres and logged in for the first time.

Step by step

  1. Create a new database for your Jomres tables in phpmyadmin. Don't add any tables to it, just create it.
  2. Upload the web installer to the root of the folder you want to install in. Let's say you've got a site in /var/www/public_html. For the purposes then of running Jomres you'll need to create a sub-folder, let's call it "bookings" so you've now got "/var/www/public_html/bookings". Put the web installer into that folder.
  3. If you're not running a server with suPHP (ie, apache runs as your ftp/ssh user") you need to ensure that the bookings folder is writable by the web server as Jomres will make a bunch of folders and files on installaton.
  4. Run this script now by going to "http://www.mysite.com/bookings/jomres_webinstall.php". It will tell you that it can't find configuration.php and ask you if you want to download and install Joomla. You do not want to install Joomla, instead we'll let install_jomres.php figure out that we're not inside Joomla and do it's own thing later on. Click on the appropriate link to continue the download and installation.
  5. This script will do several things. First it'll check that some folders are writable, then it'll download the most recent copy of Jomres from our servers. It'll unzip that file into /var/www/public_html/bookings/jomres and eventually give you the option to configure Jomres using install_jomres.php.
  6. When you run install_jomres.php for the first time it'll see that index.php doesn't exist in the /var/www/public_html/bookings directory and realise that you're installing Jomres SA. It will present you with various input fields for things like your mysql username, password and the database name, so use the database name for the database you created in step 1. Click the "Perform Jomres Standalone Pre-install database and config file creation" button to continue.
  7. Finally you will be prompted to input your license key. If you're installing on localhost, you'll be given a key to use, otherwise you'll need to use the license key you purchased from jomres.net.

That's it, you're done. To log into the front end of your site go to "http://www.mysite.com/bookings/jomres/", to go to the administrator area, go to "http://www.mysite.com/bookings/jomres/index.php?admin".

Customisation

On installation a new file jomres_standalone_config.php is created in the /jomres directory.

All other files to run SA are contained in the /jomres/libraries/jomres/cms_specific/jomressa/ folder and these are the ones you'll want to edit.

The template files, which use patTemplates for page rendering administrator and frontend views, are in /jomres/libraries/jomres/cms_specific/jomressa/templates/admin and /jomres/libraries/jomres/cms_specific/jomressa/templates/frontend respectively. Css files are in /jomres/libraries/jomres/cms_specific/jomressa/templates.

If you want to edit any of the configuration options that aren't covered by the normal configuration options mentioned elsewhere in this manual, you'll need to use ftp/ssh to edit jomres_standalone_config.php manually.

Other notes

Exporting data from Jomres SA into Joomla

Users are not created in the administrator area like they are in CMSs. Instead they're created when somebody uses the registration feature to register on the system.

Personal tools