documentation.php

<?php
	// TubeKit Beta 4
	// http://www.tubekit.org
	// Author: Chirag Shah
	// Date: 08/08/2009
	require_once("header.php");
?>
	<br>
	<table class="body" width=90%>
		<tr>
		<td>[ Note: You are looking at the local copy of the documentation. The latest documentation, including a video tutorial, can be found online <a href="http://www.tubekit.org/documentation.php">here</a>. ]<br><br></td>
		</tr>
		<tr>
		<td>
		<b>Getting Started</b>
		<ol>
		<li><a href="http://www.tubekit.org/download.php">Download</a> <i>TubeKit</i>.</li>
		<li>Make sure you have other tools downloaded and configured as listed on the download page. <i>TubeKit</i> has been tested on Linux and Mac and it should work fine with any other UNIX-based system.</li>
		<li>Move the dowloaded zip file to a place where your web-server can see it. Unzip the file. This should create a directory called 'TubeKit'.</li>
		<li>Create a subdirectory in 'TubeKit' directory with a name of your project. For instance, if you want to create a crawler for travel related videos, you might want to create a subdirectory called 'Travel'. Make sure your web-server has write permissions to the project directory.</li>
		<li>Point your browser to 'TubeKit' directory through the web-server. If you have a standard configuration, this could be http://127.0.0.1/TubeKit. Ask your system administrator if you are not clear about using the web-server.</li>
		<li>Click on 'Setup' and fill in the details. Description of these fields is given below.</li>
		</ol>
		</td>
		</tr>
		<tr>
		<td>
		<b>Basic Configuration</b>
		<ol>
		<li>Specify a name of your project. Make sure this is same as the name of the directory that you created for your project. In the example given above, this will be 'Travel' (watch for the case).</li>
		<li>Give a prefix. This will be used to name the files generated. For travel project, this could be 'tr'.</li>
		<li>Give the path to store the crawler (visible to the web-server). For our example above, this could be /home/public_html/TubeKit/Travel. DO NOT include '/' at the end. <i>TubeKit</i> will create two subdirectories in there: one for storing flash videos, and the other one for MPEG videos.</li>
		</ol>
		</td>
		</tr>
		<tr>
		<td><b>Database Setup</b>
		<ol>
		<li>Provide the host name. If the database is on your local machine, this would be 'localhost'.</li>
		<li>Give a name for your database. For instance, 'travel'.</li>
		<li>Provide username for your MySQL account.</li>
		<li>Provide password for your MySQL account.</li>
		</ol>
		</td>
		</tr>
		<tr>
		<td>
		<b>YouTube Setup</b><br>
		Select from 17 different attributes to crawl for each video. You can select an attribute to be collected only once (the first time that video is crawled), every time, or never.
		</td>
		</tr>
		<tr>
		<td><br>
		<b>Crawling Setup</b><br>
		Specify when each of the components should be executed on a regular basis. If something is not relevant, put '*'. Brief description of these components is given below.
		<ol>
			<li>Execute queries (component-1): run the seed queries on YouTube and collect the top 100 results. Each time there is a new video, extract the attributes that are marked to be collected only once.</li> 
			<li>Crawl (component-2): look into the list of videos resulted by executing the queries, go back to YouTube and extract the 'Every time' marked attributes for those videos.</li>
			<li>Download videos in Flash format (component-3): YouTube has videos in flash format. We use a third party tool called 'youtube-dl' to download flash videos.</li>
			<li>Convert videos to MPEG (component-4): it may be helpful to have videos in more standardized format such as mpeg. This component does exactly that using 'ffmpeg'</li>
		</ol>
		Note: typically, you should put component-1 run first. It should take a few minutes based on the number of queries. Running component-2 after component-1 is finished is a good practice, so that you have the information about all the new results for the queries that you have. Components 3 and 4 can be run any time. Scheduling is optional; if you want, you can run all the components manually.
		</td>
		</tr>
		<tr>
		<td><br><b>What happens next?</b><br>
		Once you click 'Run Setup', the following things happen.
		<ol>
		<li>Configuration paramaters are stored in project_directory/config.php.</li>
		<li>Other scripts are created and stored in the project directory.</li>
		<li>Database is created.</li>
		<li>Tables for queries, crawl-once, and crawl-everytime are created.</li>
		<li>A file is created that lists your cron jobs (scheduled events on a UNIX system). Use this file to schedule your cron jobs ('crontab cron_file_name' command) or append to your existing cron jobs (using 'crontab -e' command).</li>
		</ol>
		</td>
		</tr>
		<tr>
		<td>You should now be able to browse your crawler by pointing your browser to that subdirectory. In our example case, it could be http://127.0.0.1/TubeKit/Travel. If you want to edit cron jobs, use 'crontab -e' command.</td>
		</tr>
		<tr>
		<td><br>Click on 'Queries' link and add seed queries in the interface that comes up. These queries will now continue to be monitored as per the configuration. If you want to edit the queries, you should directly login to your MySQL database and access the table 'prefix_queries'.</td>
		</tr>
	</table>		
<?php
	require_once("footer.php");
?>