------------------ The Interactive Bookmarks ----------------------- Contents: 1. Step by step installation guide. 2. Sample bookmarks 3. Banners and categories editing tool 4. Using standalone categorized banner script ==================================================================== 1. Step by step installation guide. Step 1. ******* Unzip all files from bookmarks.zip preserving directory structure. You should get the following files and directories: / readme.txt - this file index.html - sample of The Interactive Bookmarks Home Page /admin index.html - blank page /cgi-bin register.pl - simple user registration script loadreg.pl - 401 error redirector showban.pl - standalone categorized banners script index.html - blank page ibview.pl - standalone bookmarks viewer /members index.html - blank page sample.htaccess - .htaccess sample file /members/ads index.html - blank page *.txt - banner files for sample categories /members/conf index.html - blank page categories.txt - sample categories file /members/cgi-bin config.pl - configuration variables index.pl - Interactive Bookmarks script admin.pl - Banners and categories management tool header.txt - sample header file footer.txt - sample footer file /members/users index.html - blank page default.* - sample configuration files for user 'default' Step 2. ******* Edit *.pl files if needed: the very first line of the following files /cgi-bin/register.pl /cgi-bin/loadreg.pl /cgi-bin/showban.pl /cgi-bin/ibview.pl /members/cgi-bin/index.pl /members/cgi-bin/admin.pl contains full pathname to Perl, default settings should be OK for most systems, but you should check with your adminiatrator if not sure. Step 3. ******* Edit configuration file /members/cgi-bin/config.pl Variable $bm_usr_dir shall be set to full path to your /members/users directory. Variable $bm_cfg_dir shall be set to full path to your /members/config directory. Variable $bm_ads_dir shall be set to full path to your /members/ads directory. NOTE: by default all variables set in assumption that your WEB server WWW root directory is /www/htdocs, and that you install Interactive Bookmarks into /www/htdocs/bmk directory. If you wish to customize pages with your own heder and footer, the following variables should be set to header and footer filenames. $header_file; $footer_file; The variable $adminemail should be set to your feedback address. Set variable $alpha_sort to any non-zero value (0 is default) if you want folders and links to be sorted in alphabetical order. Set variable $viewer_url to URL of you ibview.pl script Step 3-a. ******* Edit if needed file ibview.pl to set correct path to config.pl, in most cases require "../members/cgi-bin/config.pl"; is OK. Step 4. ******* Upload all files to your WEB server preserving directory structure. Step 5. ******* Change file masks for the following files/directories: /admin - 777 /cgi-bin - 755 /cgi-bin/register.pl - 755 /cgi-bin/loadreg.pl - 755 /cgi-bin/showban.pl - 755 /cgi-bin/ibview.pl - 755 /members/ads - 777 /members/ads/*.txt - 666 /members/conf - 777 /members/conf/categories.txt - 666 /members/cgi-bin - 755 /members/cgi-bin/config.pl - 755 /members/cgi-bin/index.pl - 755 /members/cgi-bin/admin.pl - 755 /members/users - 777 /members/users/default.* - 666 Step 6. ******* Protect /members directory. If your site already uses some kind of global protection based on .htaccess files just arrange for the /members directory to be in protected area, otherwise: - edit /members/sample.htaccess file - * first line shall be set to full path of /admin/.htpasswd file (the file will be created automatically later); * fifth line shall be set to relative path of /cgi-bin/loadreg.pl file (the path is relative to www server root) - rename /members/sample.htaccess to /members/.htaccess - edit /cgi-bin/register.pl file: variable $reg_adm_dir should be set to full pathname to your /admin directory - edit /cgi-bin/loadreg.pl file: variable $url should be set to www server root relative pathname to /cgi-bin/register.pl script Do not forget upload changed files to your www server. Step 7. ******* Now you can run bookmarks either through /index.html or directly through /members/cgi-bin/index.pl ==================================================================== 2. Sample bookmarks. When new user enters Interactive Bookmarks his/her profile being loaded with sample bookmarks. The user name who keeps sample bookmarks defined by $defaultuser variable in /members/cgi-bin/config.pl file and by default set to 'default'. Thus registering user with the name 'default' and editing his profile you can define sample bookmarks. ==================================================================== 3. Banners and categories editing tool. Definitions of categories are stored in /members/conf/categories.txt file. Each record consists of 2 fields - filename|description, where filename - is file name used to store banners for this category (do not use any extentions) description - is the description of the category, your users will see only this info Banners are stored in raw text files in /members/ads/ directory. Each line of these files holds html banner code, the one which generated for you by banner and click networks like LinkExchange and Click2Net. In order to avoid manual editing of all these files you can use supplemental /members/cgi-bin/admin.pl script. When invoked for the first time it will ask you for admin password and will store it for further reference. This is why it is important to run this script at least once upon its installation. ==================================================================== 4. Using standalone categorized banner script. You can serve your categorized banners to all pages of your site. To facilitate this feature simple script /cgi-bin/showban.pl included into distribution package. In order to include categorized banner into html page use the following code where 'categoryname' is 'filename' field as defined in categories.txt file (see chapter 3 for further details). Please note, that you WEB server must support SSI (most do).