User Tools

Site Tools


documentation:getting_started

Getting Started

This guide will explain in simple terms how to get started. By the end you will have added Commentics to your site and be ready to use it.

There are two steps, Installation and Integration. Before we begin, we should check a few things:

Pre-checks

Does your web server meet the minimum requirements? If you don't know then that's okay, Commentics will check them during the installation and will tell you if you can proceed. On the other hand, you may want to ask your host with an email like this one:

Hi,

I'm interested in running the open source script Commentics (commentics.org) and I was wondering if my account supported the following:

PHP 5.2 or higher (Required)
MySQL 5.0.7 or higher (Required)
Apache (Required)
cURL (Recommended)

Is Magic Quotes disabled? If not, can you disable it?

Thanks!

cURL is not essential, however you will need it if you want the admin panel to do a version-check and retrieve the latest project news. Magic Quotes should be disabled, otherwise you will see extra slashes โ€œ\โ€ on your page.

Lastly, it might be obvious but Commentics is a PHP script so you will need a PHP file to add the script to. If your file is a HTML file then see here.

Installation

Installing Commentics is fairly quick and simple. It has an installer interface which adds the database tables for you. The hardest part for some people is setting read-only file permissions for the database file, however the Install guide will explain this and if you do struggle then you can actually skip it and let the admin panel do it.

To install, complete this guide.

After installation you will see a checklist. There is a helpful Checklist Guide (PDF) for that.

Integration

Next you will need to add Commentics to your page(s). This involves opening the file of your page and adding a few pieces of code inside it.

To integrate, complete this guide.

If you are integrating with a popular script there may be a tutorial on the Implementations page.

What Next?

After you have integrated the script into your file, simply view the page in your web browser. Commentics will automatically register it in the database and it should now be listed in the admin panel in Manage โ†’ Pages.

documentation/getting_started.txt ยท Last modified: 2013/02/16 20:45 by steven