Installation and Configuration Documentation
for
----------------------------------------
            REPO INDEXER (RI)
----------------------------------------
by Patkós Csaba

an MRB - Mandrivausers Romanian Backports Project by MandrivaUsers Romania (www.mandrivausers.ro)



CONTENTS:
1. General Information
2. Installation
3. Configuration
4. Additional Information

1. GENERAL INFORMATION
----------------------

Project Webpage: http://mrb.mandrivausers.ro/ri/

Repo Indexer is PHP based web-application for generating online folder views of Linux repositories. It is developed as part of the MRB - Mandrivausers Romanian Backports Project and it's main goal is to offer folder listing for Mandriva Repositories.

However, the application is not distribution dependent and it can run for other Linux Distributions too if you configure it correctly.

Repo Indexer is useful if you want more than just a simple folder listing or if your web-server doesn't allow folder listing.

Features 
- User-defined multiple Folders
- User-defined multiple Architecture
- User-defined multiple Distribution Versions
- Advanced and Simple Search
- User configurable design via CSS
- Standar complient HTML 4.01 and CSS 2
- Requires only PHP and execution rights for /bin/rpm
- Requires writing permission only to it's own folder and subfolders



2. INSTALLATION
---------------

Software requirements:
- PHP capable webserver
- standard PHP enabled without any special module or library
- execution rights to /bin/rpm (if your "rpm" application is somewhere else, feel free to modify the application code, or link the executable into /bin)


Just extract the contents to the folder where you want it accessible from the WEB.

For example, if your folder for RI si /var/www/html/ri, extract it there. Keep unchanged ALL folders and subfolders from within the archive. 

If your webserver follows symlinks, you can move the folders ans link them as their original names were.




3. CONFIGURATION
----------------

Configuration is done by Repo_Indexer/repoidx_config.php as explained in the file

//Page Title and Header Image
$pageTitle="MRB - Mandrivausers Romanian Backports";                                                                                                         
$headerImage="http://www.mandrivausers.ro/files/logo_site.png";

//Your Site name and the short version of it. This will appear on the home/first page.
$siteName= "Mandrivausers Romanian Backports";
$siteNameShort= "MRB";

//Whatever you want to write in your page footer. You can use any HTML tags as long as you SINGLE quote the variable
//and use DOUBLE quotes inside the HTML sintax
$pageFooterText='MRB - Mandrivausers Romanian Backports is a Mandrivausers Romania Project<br>
<a href="http://www.mandrivausers.ro">http://www.mandrivausers.ro</a>';

//The base dir of you repository. This MUST be in the current folder, you can't use "../" to go back. Note "/" at the end of variable value. You can also link to the folder where your repository is as long as you put the link inside the main folder of RI.
$dirBase= "MRB/";
//Distro folders, subfolders of $dirBase. Note "/" at the end of variable value.
$distros= array("2009.1/","2010.0/");
//Arch folders, subfolders of $distros. Note "/" at the end of variable value.
$archs= array("x86_64/","i686/");
//RPM folders, subfolders of $archs. NO "/" at the end
$dirs= array("MRB-testing","MRB-rpms","MRB-srpms");

//Alternate background color in file listing
$altBGColor="#eeeefc";

//Icon used in listing, use full path if it's not in the same folder with index.php
global $listIcon;
$listIcon="favicon.ico";


The design of the application can be altered by modifying Repo_Indexer/default.css . Most of the design is changeable from there, however some expects are hardcoded to maintain a certain framework in place. The classes are named so that they are self-explanetory.




4. ADDITIONAL INFORMATION
-------------------------

This is free software and comes with no waranty. It is released under GPLv3 license. The license is included within the applciation in folder Repo_Indexer/gpl-3.0.txt.

For bug reports, feature requests and feedback access the application's forum: http://www.mandrivausers.ro/forum/index.php/board,32.0.html

----------------------------------------------------------------------------------------------

Documentation written by Patkós Csaba.