IndieScan v1.2 --- For Apache/FreeBSD servers Copyright (c) 2002, The PAN Network All Rights Reserved Versions for other systems (Linux, Windows, etc.) will soon be available. By the end of 2002, the following systems will be supported: AIX BSD/OS DEC OSF1 FreeBSD HP-UX IRIX Linux OpenBSD SunOS Unix V1.xx Win32/W2K Installation ============ Unzip the distribution file in your cgi-bin directory. It will automatically create a directory called /indiescan and will contain all the files needed to run the program Then CHMOD the directory files to 775. Also be sure to set your admin password, as per the "Setup / Config.dat" section. Setup ===== 1. The .htaccess File 2. Creating, Editing, and Validating a Database of Song Title Links 3. Config.dat 4. Activation & Monitering 1. The .htaccess File In the directories where you have your song files, you will need to create a file called ".htaccess", with the following directives: AddType audio/x-pn-realaudio ra rm ram AddType audio/mpeg mp3 m3u AddType audio/x-ms-wma wma Action audio/x-pn-realaudio /cgi-bin/indiescan/indiescan Action audio/mpeg /cgi-bin/indiescan/indiescan Action audio/x-ms-wma /cgi-bin/indiescan/indiescan Notes: If you already have an .htaccess file in your directory, just add the directives to the bottom of it. If you put indiescan in a different cgi-bin directory than the default, be sure to edit the .htaccess file to include the directory path to the indiescan program file (in the "Action" directive). Be sure to include the period "." at the beginning of the filename (it's ".htaccess", not "htaccess"). Otherwise your server will ignore it. If you have nested subdirectories, you only need one .htaccess at the top level directory. 2. Creating, Editing, and Validating a Database of Song Titles In order for your songs to be recognized by the IndieScan charting system, you will need to enter the song titles, artist name, etc. into the database module provided in the program. Tracking file downloads is useless unless there's a link to the title of the song and the name of the artist, and unfortunately, this is one aspect of the system that can't be automated. You have to enter the titles manually. You do this with your web browser pointed to /cgi-bin/indiescan/indiescan?maint=add For example, if your domain is whatever.com, go to http://www.whatever.com/cgi-bin/indiescan/indiescan?maint=add The program will then launch the Song Title Database Maintenance Module. You can always go back to edit and/or delete entries, so if you make any mistakes, no problem. To edit titles, use the ?maint=add switch: http://www.whatever.com/cgi-bin/indiescan/indiescan?maint=edit You can also validate titles (to make sure there are no broken links or titles that are getting downloaded that you forget were even there). Use the ?maint=validate switch: http://www.whatever.com/cgi-bin/indiescan/indiescan?maint=validate 3. Config.dat Your admin password is stored in the config.dat file. This is used to validate access to the song title database. It is strongly recommended that you change the password immediately so that no one can mess with your song title database. Be sure not to use any spaces or non-alphanumeric characters in your password. Be sure to also add your admin_email address in the field provided in the config.dat file. This is "folded in" to the identifying domain header info from your daily chart report, just in case there's a problem and we need to contact you ASAP. It will also help us to contact you about bug fixes, updates, etc. etc. And btw, if your email address changes, edit the config.dat file so that it's current. Email addresses are kept completely confidential, and only used for emergency alerts and update notifications; they are never given out to anyone for any reason, never posted with chart data, or otherwise made public in anyway whatsoever, so if you're concerned about SPAM, don't be. The Config.dat file is also used if you have a site that asks registered users to login, and gives them a cookie that includes their name. PAN's patent-pending "DIF" anti-theft technology is built-in to the program, just in case you might want to use it at some point, and it will need to know your cookie setup so as to help you identify the people downloading files. If this is not you, or you don't want it, don't worry about it. 4. Activation & Monitering Once you've got everything setup, send an email message to indiescan@pan.com to let us know you're ready to roll (or rock, as the case may be), and thereafter anytime someone downloads or listens to one of your songs, it will be included in the daily chart compilation of all song activity on the internet. Control Files ============= Once you have everything setup, the rest is automated, and you shouldn't have to do anything else unless you add new songs to your server, remove some, or move them around, in which case you'll need to run the "maint" program to make the necessary changes. And just in case you're wondering what those files in the directory are, the actual program files are the following executable binaries: indiescan the main program Base64.so program support lib/module Dumper.so program support lib/module IO.so program support lib/module Socket.so program support lib/module As the system is used, you'll see several files automatically appearing in your indiescan directory. These are: user.dat an audit trail of completed file downloads or playbacks access.dat an audit trail of attempted file downloads or playbacks, completed or not today.dat a subset of user.dat comprising all the file downloads since the last poll titles.dat the song file database of titles, artist names, etc. data.txt transaction code to track number of song file download requests license.dat the IndieScan program license validation file Standard Disclaimer =================== DISCLAIMER OF WARRANTIES AND LIABILITY DISCLAIMER OF WARRANTIES AND LIABILITY The Service and related Software is provided AS IS and AS AVAILABLE, without warranty of any kind. PAN EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO: (A) ANY WARRANTIES AS TO THE AVAILABILITY, ACCURACY, COMPLETENESS, CURRENTNESS OR RELIABILITY OF THE CONTENT AVAILABLE THROUGH THE SERVICE, OR THE SERVICE ITSELF; (B) ANY WARRANTIES THAT THE SERVICE WILL BE UNINTERRUPTED, TIMELY, SECURE, OR ERROR FREE, OR THAT SOFTWARE DEFECTS WILL BE CORRECTED; AND (C) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. YOU ACKNOWLEDGE AND AGREE THAT ANY MATERIAL AND/OR DATA DOWNLOADED OR OTHERWISE OBTAINED OR PROVIDED THROUGH THE USE OF THE SERVICE OR SOFTWARE IS DONE AT YOUR OWN DISCRETION AND RISK AND THAT YOU WILL BE SOLELY RESPONSIBLE FOR ANY DAMAGES TO YOUR COMPUTER SYSTEM OR LOSS OF DATA THAT RESULTS FROM THE DOWNLOAD OF SUCH MATERIAL AND/OR DATA. NO ADVICE OR INFORMATION, WHETHER ORAL OR WRITTEN, OBTAINED BY YOU FROM PAN OR THROUGH THE SERVICE SHALL CREATE ANY WARRANTY NOT EXPRESSLY MADE HEREIN. PAN, ITS OFFICERS, DIRECTORS, OWNERS, AGENTS AND EMPLOYEES, SHALL NOT BE LIABLE TO YOU OR ANYONE ELSE FOR ANY LOSS OR INJURY RESULTING FROM USE OF THE SERVICE OR SOFTWARE, CAUSED IN WHOLE OR IN PART BY ITS NEGLIGENCE OR CONTINGENCIES BEYOND ITS CONTROL IN PROCURING, COMPILING, INTERPRETING, REPORTING OR DELIVERING THE SERVICE AND ANY CONTENT THROUGH THE SERVICE. IN NO EVENT WILL PAN, ITS OFFICERS, DIRECTORS, OWNERS, AGENTS AND EMPLOYEES, BE LIABLE TO YOU OR ANYONE ELSE FOR ANY DECISION MADE OR ACTION TAKEN BY YOU IN RELIANCE ON SUCH CONTENT. PAN, ITS OFFICERS,DIRECTORS, OWNERS, AGENTS AND EMPLOYEES, SHALL NOT BE LIABLE TO YOU OR ANYONE ELSE FOR ANY DIRECT, CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR SIMILAR DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, RESULTING FROM THE USE OR THE INABILITY TO USE THE SERVICE OR SOFTWARE. YOU AGREE THAT THE LIABILITY OF PAN, IF ANY, ARISING OUT OF ANY KIND OF LEGAL CLAIM (WHETHER IN CONTRACT, TORT OR OTHERWISE) IN ANY WAY CONNECTED WITH THE SERVICE OR SOFTWARE OR THE CONTENT IN THE SERVICE SHALL NOT EXCEED THE AMOUNT YOU PAID PAN FOR THE USE OF THE SERVICE.