21TORR Interactive Labs

User Guide

Prerequisites

  • Linux or Windows
  • PHP (version 5.2 or higher)
  • MySQL (version 5.1 or higher)
  • SimpleXML
  • curl
  • Image Magick
  • prototype
  • script.aculo.us
  • cronjobs

Installation

To install the software unzip the downloaded file into your webserver and insert the MySQL Statement into your Database.

Unzip

Unzip the downloaded file and paste all files, except the cron directory, on your webserver (htdocs). Paste the cron folder one level obove the htdocs directory.

Insert the MySQL Statement

Insert the following Statement in your database.

SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";
 
CREATE DATABASE `planet` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
USE `planet`;
 
CREATE TABLE IF NOT EXISTS `entries` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `entry_id` varchar(250) NOT NULL,
  `title` varchar(250) NOT NULL,
  `link` varchar(250) NOT NULL,
  `description` text,
  `publication_date` datetime DEFAULT NULL,
  `feeds_id` int(11) NOT NULL,
  PRIMARY KEY  (`id`),
  UNIQUE KEY `entry_id` (`entry_id`),
  KEY `fk_Entries_Feeds` (`feeds_id`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8 AUTO_INCREMENT=1471 ;
 
CREATE TABLE IF NOT EXISTS `feeds` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `feed_url` varchar(250) NOT NULL,
  `title` varchar(250) NOT NULL,
  `updated_at` datetime NOT NULL,
  `description` text NOT NULL,
  `site_url` varchar(250) NOT NULL,
  `verification` tinyint(1) NOT NULL DEFAULT '0',
  `favicon` varchar(250) DEFAULT NULL,
  PRIMARY KEY  (`id`),
  UNIQUE KEY `feeds_feed_url` (`feed_url`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8 AUTO_INCREMENT=99 ;
 
ALTER TABLE `entries`
  ADD CONSTRAINT `fk_Entries_Feeds` FOREIGN KEY (`feeds_id`) REFERENCES `feeds` (`id`) ON DELETE CASCADE ON UPDATE NO ACTION;

Edit config.php

Edit the MySQL settings in config/config.php

define('MYSQL_SERVER', 'yourServer');
define('MYSQL_USER', 'yourName');
define('MYSQL_PASSWORD', 'yourPassword');
define('MYSQL_DATABSE', 'yourDatabaseName');

Explanation of the Feed Check

Check if

  • the input field is empty
  • the given url have right syntax
  • the target is a RSS or ATOM feed
  • teh feed is not even in the databse

Inscribe a feed

To inscribe a feed, you only have to type or copy your feed adress in the inputfield and confirm or change the suggested name.

Email Verification

The Email verfication ist enabled by default. You can disabele or enabel in the config.php file.

define('EMAIL_VERIFICATION', '1');

1 = verification ON
0 = verification OFF

Email settings

Insert your email adress to recieve the mails

define('SENDER_MAIL','yourName@yourSite.com');

Insert a Sender adress

define('SENDER_NAME',TITLE);

The Sender name, by default the site title

define('RECIEVER_MAIL','yourName@yourSite.com');

Insert s Recipient adress

define('RECIEVER_NAME','Planet Administrator');

The Recipient name

Themeing

You don't like the planetBase Theme? No Problem, create your own.

  1. Copy the planetBase folder in templates/themes/ rename it, and feel free to change.
  2. Copy the planetBase.css file in style/ rename it, and feel free to change.
  3. Edit the config.php in config/

Change site title and theme name

define('TITLE', 'PLANET BASE');
define('THEME', 'planetBase');

Make sure that the theme folder and the .css have the same name and this name is also the theme name in config.php

Cronjob

There are two cronjobs in the cron/ directory.

  1. update_all_feeds.php
  2. update_all_favicons.php

update_all_feeds.php

Update all Feeds and insert new Entries in the database.

update_all_favicons.php

Update all favicons and insert their URL in the databse.

It's your decision how frequently you run this cronjobs.

Entries per Site

You can set the number of Entries per site in the config.php .

define('SITE_RANGE', '20');

It is set on 20 entries per page by default. Feel free to change.

en/projects/planet/guide.txt · Last modified: 2009/10/28 12:35 by marcelwe
Contact 21TORR AGENCY GmbH Index