Location: PHPKode > projects > Esvon Personals > esvon-personals/install.txt
// --------------------------------------------------------------------------
//
// Esvon Classifieds v.4.0
// Copyright(C), Esvon LTD, 2001-2010, All Rights Reserved.
// E-mail: hide@address.com
//
// All forms of reproduction, including, but not limited to, internet posting, 
// printing, e-mailing, faxing and recording are strictly prohibited.
// One license required per site running Esvon Classifieds. 
// To obtain a license for using Esvon Classifieds, please register at
// http://www.esvon.com/pg/products/p_classifieds/
//
// --------------------------------------------------------------------------


Thanks for purchasing Esvon Classifieds.
This document will explain how to install and configure
the program on your web server.  

TABLE OF CONTENTS
--------------------------------------------------

    1. Welcome
	1.1 About the Script
	1.2 System Requirements
	1.3 Software License
    2. Installation
	2.1 Installation Instructions
	2.2 Directories Structure
	2.3 Settings explained
	2.4 Modifying Templates
	2.5 Configuring Custom Database Fields
	2.6 Security Concerns
    3. About Esvon.com
	3.1 About Us
	3.2 Support
	3.3 Products
	3.4 Contact


1. Welcome
====================================================


1.1 About the Script
----------------------------------------------------

  Esvon Classifieds - where databases come to life. It was created with 
high performance and scalable technology using PHP and MySQL, some of 
the key features which distinguishes it from similar portal solutions 
are listed below.

  Category specific ad fields - you can have property, automotive, personals, 
employment categories and more, all in one package ! 
  Powerful modules system - you pay only for the features you need 
  Search engines friendliness (search engine friendly URLs support, 
"mod_rewrite" is required) 
  Multiple payment gateways support (you can accept credit cards, Paypal, 
checks, cash orders, wire transfers at once) 
  Major payment gateways built-in for automated payments processing 
(Authorize.Net, Paypal, 2Checkout, Worldpay), others can be added 
  Ability to charge for listing placements (category specific pricing 
supported), for listing extra options (Priority Ranking, Extra Visibility, 
Featuring) and for membership 
  Ability to have private sellers (posters) who pay per listing and dealers 
who pay monthly and can add as many listings as you allow 
  Advanced DB queries caching system 
  100% template based layout + language file allows website translation 
into any language and full control of design elements 
  All benefits of static HTML content using mod_rewrite technique and 
DB queries caching 
  Custom ad field types (text boxes, menus, checkboxes, radiobuttons, 
unlimited images, files to upload, etc.) 
  Outstanding performance and scalability, unlimited sotfware usage scope 
  Many powerful features not normally available in software packages within 
this price range 

 Any solution where category/items listing is needed may be built 
in hours. Performance and scalability are everything! 

  This application could easily even be turned into a resource index or 
some other custom application. The possibilities are endless.


1.2 System Requirements
----------------------------------------------------
Realty Manager requires the following to run:

   * PHP v4.2 or later (http://www.php.net/)
   * Web Server (Unix or Windows)
   * Zend Optimizer (http://www.zend.com/store/products/zend-optimizer.php)


1.3 Software License
----------------------------------------------------
Please take the time to carefully read the license agreement included in this
package.  The license agreement details the terms and conditions of the
Software License for Esvon Classifieds. Make sure you have read and
understand these terms and conditions before using the software. 


2. Installation
====================================================


2.1 Installation Instructions
----------------------------------------------------
 Note that this guide does not describe how to install a webserver or PHP 
or a database server. See the documentation for these programs on how to 
install those. This installation guide assumes that you already 
have a working webserver with PHP support and a MySQL database 
installed.

 But before you proceed with software upload, you may want to make sure these 
questions were addressed:

1) Buy your domain name (i.e. godaddy or network solutions)
2) Setup a hosting account (i.e local web hosting company, HostingMatters.com,
KnownHost.com, etc). 
Make sure your server package is capable of supporting PHP, MySQL, and Zend Optimizer.
3) Setup a database in your hosting account, you'll need to know a database host, 
a name, a username, and a password.
4) Create a text file and take note of username, database name, password, 
and host address. You will need these later on.

 There are two ways to upload the software via FTP. Either you upload the package and
extract it on the server or you upload the already extracted files. As a rule
of thumb, whenever shell access is available, you should extract the archive on
the server because it will save you some time and ensures all files are
copied to their destination. In this case you will skip steps 1 and 2 below.

 If there's no shell access or you simply don't know how to operate on such a shell 
you can upload the single files to your server. Your FTP client must be configured 
to treat *.php files as binary files. Uploading them in ascii mode may break the application. 
Ask your FTP client's vendor how to configure it, if you feel unsure about it 
and its documentation doesn't give any hints.


1. Unzip the distribution archive on to your computer making sure to
   preserve the directory structure that is stored in the zip file.

2. Upload all files to your server using ftp client (in BINARY mode).
   In most cases you have to upload it under "/public_html/" or "/html/" 
   directory which is your public html directory.

3. Setup file system permissions. There are 2 ways to setup directories/files 
permissions, automatically (step 3A) or manually (step 3B).

3A. Automatic permissions setup.

  Use Esvon Classifieds Files Permissions Express Setup script which can
be downloaded from Support Center > Downloads section :
http://www.esvon.com/support/index.php?_m=downloads&_a=view
Unzip downloaded file and follow the readme instructions that come with it.
This tool connects via FTP to the server where Esvon Classifieds is installed and executes 
series of necessary CHMODs. You can always set the necessary permissions manually 
if you don't want or can't use this tool by some reason.

3B. Manual permissions setup.

   Make the following directories writeable (777):

   /tpl/
   /files/
   /files/small/
   /files/cache/

   Make the following files writeable (666):

   /inc/application.php
   /tpl/*.*

   where *.* means all files under this directory

   Template files for all modules under "/modules/_module_name_/tpl/" dirs
   where "_module_name_" is module name

  ( all files under these directories :
/modules/Cron_General/tpl/
/modules/Faq/tpl/
/modules/Favorites/tpl/
/modules/.../tpl/ )

   Template files for all fieldsets in "/tpl/db_fields/" dir

  ( all files under these directories :
/tpl/db_fields/auto/
/tpl/db_fields/general/
/tpl/db_fields/job/
/tpl/db_fields/.../ )

4. You should have empty MySQL database created (create MySQL database if not)
Note: "CREATE TEMPORARY TABLE" privilege should be granted on mysql account since MySQL 4.0.2
(ask your hosting support about this if you will have SQL related errors after installation).

5. Run install.php ( enter http://yourdomain.com/install.php in your browser ).

   If you see a message that you don't have Zend Optimizer installed, please contact
   your hosting provider and request to install Zend Optimizer for you 
   ( http://www.zend.com/store/products/zend-optimizer.php ), see 2nd question at
   http://www.esvon.com/pg/products/p_classifieds/faq/ for more information.

   Enter configuration vars (database connection settings, site path, etc) and
   click "Install".

6. If installation was successful, delete install.php file.
   CHMOD inc/application.php to 644

7. Go to the Esvon Classifieds administrator area 
   (eg.: http://www.yourdomain.com/admin/index.php). 

   For the login and password use: adm/adm (default values), go to "General Setup" 
and "Fieldsets Options" where you can update all necessary settings.
   You can start entering some test ads.

8. You can see front-end at http://www.yourdomain.com/index.php

9. Please learn about the most important templates to edit in templates.txt file.


Admin Area Hints (todo list after installation) :

 - Go to "Application Setup" and update Admin Email, Site URL and other settings.
Don't forget to change your default login/password to something more secure
 - Module-related information (including integration instructions) can be found
by clicking "Help" next to each module in Admin Area -> "Manage Modules" section.


2.2 Directories Structure
----------------------------------------------------
We describe software directories here to help you better understand software
structure and to obtain certain basis for software customizing if you are
interested in it.

"admin/"       - for php files handling Admin Area functionality
"cron/"        - it contains cl_cron.php - script for cron job
"docs/"        - for software related documentation 
"files/"       - uploaded files and images are stored there
"files/small/" - thumbnails directory
"inc/"   - for php library files and configuration file (application.php)
"inc/blocks/"  - blocks directory. Blocks are pieces of HTML code that are used in 
template files for dynamic information displaying (e.g. recently viewed items,
categories, who is online, featured/random items, etc). See "inc/blocks/readme.txt"
for more details. This directory has php files in source code and they can be used 
as programming examples
"inc/pages/"   - front-end pages directory. For example output from login.php file 
residing in this directory you will see using URL "index.php?page=login".
This directory has php files in source code and they can be used as programming examples.
"inc/pay_modules/" - for payment modules
"modules/"     - modules directory. Each module has "readme.txt" file with module specific
instructions which are available from Admin Area -> Manage Modules -> Help links also.
"tpl/"         - templates directory
"tpl/db_fields/"   - fieldsets directory (refer to "docs/fieldsets.txt" for more details)
"upgrades/"    - upgrade scripts directory (see "upgrades/readme.txt" for more information)


2.3 Settings explained
----------------------------------------------------
Callback URL for automated payment processing (with 2Checkout, Authorize.Net, 
WorldPay, etc) is http://www.yourdomain.com/ipn_notify.php

However if your website is setup to require HTTP authorization, instant payment notification 
will not work till you open your website.


1/ "Fieldsets Options"

This is the place where fieldset specific settings and behaviour are defined.
Layout settings: you can have your 3 pages (Place Ad, Modify Ad, Advanced Search)
generated on the fly or you can have them customized with total layout control.

Let's compare these 2 options.

 a/ Generated on the fly :

   - benefits : You can change the ad fields without caring about layout of the page.
     All new fields appear and deleted fields disappear automatically. This can be
     a good choice if you have a lot of ad fields, or you have no special layout 
     requirements, or you want it up and running now and are going to customize 
     the layout in the future.
   - disadvantages : You have little control over the page layout and cannot insert 
     hints, notes or any HTML next to each field, for example.

 b/ Custom pages :

    You have complete control over the page layout and can insert 
    hints, notes or any HTML next to each field, for example.
    In this case you care about the placement of each ad field at the page. 
    The placeholder for each ad field has the following format: ##ctl_ID##, 
    where ID is the ad field ID.
    - disadvantages: You must have HTML knowledge to control the layout of each 
    field and it might take some time getting it set up exactly like you like it.

 The default Place/Modify Ad pages that come with classifieds package are 
generated on the fly.

 To create custom page, in Admin Area -> Fieldsets Options please select desired fieldset 
and check off 'Generate "Place Ad" page ?' and/or 'Generate "Modify Ad" page' options.
After this you can copy add.htm (or/and modify.htm, search_adv.htm) file(s) from "tpl/" 
directory into your fieldset directory (like "tpl/db_fields/horse/", where "horse" is 
fieldset name) and customize it in the way you want.


2.4 Modifying Templates
----------------------------------------------------
All templates used by the program can be customized to match 
the look and feel of your site.  These files aren't displayed 
directly on your site but rather are used as templates to "publish" 
additional files that are.

When editing these template files we recommend you use a text based 
HTML editor or online templates modification in admin area.  
The templates use special tags to define and insert information 
and using WYSIWYG HTML editor can be problematic.

Each template has a number of variables or "placeholders" that can be 
inserted to tell the program what information to insert in the published 
page.  A placeholder looks like this ##name##, a word or series of 
letters and number surrounded by two #.  

Variable modifiers can be used in placeholders, e.g. :
##var|count_words##, ##var|strip_tags##, ##var|truncate:10:".."##, 
##var|trim|nl2br##, etc.

Here is the list of available modifiers (almost all are named as corresponding
php functions) : addslashes, htmlspecialchars, htmlentities, nl2br, 
strip_tags, trim, ucfirst, ucwords, urlencode, count_words, lower,
upper, truncate[:max_len:trail_chars].

Another way that placeholders are sometimes displayed in the source code 
is by using a special tag so the actual placeholder isn't visible when viewing 
the template, like this:

<!-- TPL_INSERT : name -->

In addition, some templates use TemplateCells.  A template
cell is a block of HTML that can be displayed or not displayed.
TemplateCell surrounding tags are 
<!-- TPL_CELL : name --> and <!-- /TPL_CELL : name -->
An example of this is on the ad where if the user
has uploaded any images they will be displayed, otherwise some
"no image available" text is displayed in there place.  


2.5 Configuring Custom Database Fields
----------------------------------------------------
Please read /docs/fieldsets.txt file carefully.


2.6 Security Concerns
----------------------------------------------------
It is important to be aware of file permissions.  When giving writen 
permission to data and other files it is important to ensure that you are not 
allowing other users that may have accounts on the web server access to your files.
In some cases where a single web server hosts many websites and users, 
one user may be able to read or write another users files if file permissions 
are setup incorrectly.

If you are concerned about security and would like more information, contact
your server administrator.


3.0 About Esvon.com
====================================================


3.1 About Us
----------------------------------------------------
Esvon.com is a new media software company which specializes in 
developing custom web based applications and publishing tools. We 
provide fast, friendly support and creative solutions for anyone doing 
business on the web. If you would like to find out how we can help you 
with your next internet project don't hesitate to contact us through
our website.

3.2 Support
----------------------------------------------------
If you require support for this product please contact us via 
email at hide@address.com

3.3 Products
----------------------------------------------------
For more information about our other esvon.com products
visit our website at http://www.esvon.com/
Return current item: Esvon Personals