OSClass - Readme

Introduction

OSClass is an open source project for classifieds. In a few steps you can build a classified site. Some features: easy installation, multi-language, extensibility through plugins, search engines friendly (sitemap, robots, urls seo-friendly) and a lot more features.

Installation

Here’s a quick step-by-step guide of the installation process:

Download and unzip the OSClass package.
Move the OSClass unzipped files to the desired location on your server.
Execute the OSClass installation script by accessing oc-installer/index.php from your browser:
- If you’ve installed it in the domain’s root directory, you’ll have to go to: http://example.com/oc-installer/index.php
- If you’ve installed it in a subdirectory inside the domain, classifieds, for example, go to: http://example.com/clasificados/oc-installer/index.php
Follow the installer’s instructions:
- Step 1: Make sure the server has the required permissions to write in the files and directories specified. This will allow you to create a basic configuration file as well as upload images, documents, etc.
- Step 2: Add your access details to the database. If you haven’t created it yet, the installer will ask for another account with permissions that allows it to do it for you.
- Step 3: Add the basic installation details and select your classfieds site’s reach: international, local, regional…
- Step 4: Choose the categories you want to use on your site. If you don’t select a category, you’ll have to add it later from your admin panel.
- Step 5: Your installation is finished! Use the automatically generated password to access your admin panel (/oc-admin).
To finalize the installation, rename the oc-installer directory in order to access the page.

How to upgrade

OSClass will show an autoupgrade message if a new (and stable) version is available. Follow the link and after a few moments you will be enjoying a new version of your favorite open source classifieds software. Had you expected more steps or difficult instructions? Sorry! but we made that easy. We recommend to do a backup before you attemp to upgrade your OSClass installation, you coud perform that from the admin panel (if you modified any core file, it will probably be replaced by new version software. Be carefull).

The Autoupgrade feature will perform the following steps for you :

Step 1: Check if there's a new version os OSClass.
Step 2: Download it.
Step 3: Unzip it.
Step 4: Remove old files, copy new ones (remember: if you edited any core file, it will probable be replaced by a new one).
Step 5: Perform changes in the tables (if necessary).
Step 6: Perform extra-actions (if necessary).

If you experienced any problem during the process, please don't hesitate in contact us in OSClass Support Forums. We recommend to perform a backup of database and files before each upgrade. You could backup your data from the "Backup" option in the admin panel. If you want to run the autoupgrade manually you could do that from the following URL : http://www.yourdomain.com/path/to/osclass/oc-admin/tools.php?action=upgrade

How to upgrade plugins

The process is pretty much as the upgrade process for OSClass core files: if a new version is available of a plugin a message will inform you. You just have to follow that link and we'll take care of the rest, after a few moments, the plugin will be upgraded. Note: not all plugin have autoupgrade feature, in that case, you should contact the plugin's author to know more about manually upgrading it.

Online Resources

If you have any questions that aren't addressed in this document, please look at the online resources:

OSClass Wiki: The wiki is where all information about OSClass is placed.
OSClass Blog: This is where you'll find the latest updates and news related to OSClass.
OSClass Support Forums: If you've looked everywhere and still can't find an answer. To help them help you be sure to use a descriptive thread title and describe your question in as much detail as possible.

License