Integration in phpBB3

It is possible to insert forum pages into the YaCy index using a database import of forum postings. This guide helps you to insert a search window in your phpBB3 pages.

Retrieval of phpBB3 Forum Pages using a database export

Forum posting contain rich information about the topic, the time, the subject and the author. This information is in an bad annotated form in web pages delivered by the forum software. It is much better to retrieve the forum postings directly from the database. This will cause that YaCy is able to offer nice navigation features after searches. YaCy has a phpBB3 extraction feature, please go to the phpBB3 content integration servlet for direct database imports.

Retrieval of phpBB3 Forum Pages using a web crawl

The following form is a simplified crawl start that uses the proper values for a phpbb3 forum crawl. Just insert the front page URL of your forum. After you started the crawl you may want to get back to this page to read the integration hints below.

URL of the phpBB3 forum main page
This is a crawl start point

Inserting a Search Window to phpBB3

To integrate a search window into phpBB3, you must insert some code into a forum template. There are several templates that can be used for phpBB3, but in this guide we consider that you are using the default template, 'prosilver':

  • open styles/prosilver/template/overall_header.html
  • find the line where the default search window is displayed, thats right behind the
    <div id="search-box">
  • Insert the following code right behind the div tag:
    <script src="http://localhost:8091/yacy/ui/js/jquery-1.3.2.min.js" type="text/javascript"></script>
       $(document).ready(function() {
          yconf = {
             url : 'http://localhost:8091/',
             title : 'YaCy Forum Search',
             width : 500,
             height : 600,
             position : ['top',30]
          $.getScript(yconf.url+'/yacy/ui/js/yacyui-portalsearch.js', function(){return false;});
    <div id="yacylivesearch">
       <form id="ysearch" method="get" accept-charset="UTF-8" action="http://localhost:8091/yacysearch.html">
          <input name="search" id="yquery" type="text" size="16" maxlength="128" title="{L_SEARCH_KEYWORDS}" class="inputbox search" value=""/>
          <input type="hidden" name="verify" value="cacheonly" />
          <input type="hidden" name="maximumRecords" value="10" />
          <input type="hidden" name="resource" value="local" />
          <input type="hidden" name="urlmaskfilter" value=".*" />
          <input type="hidden" name="prefermaskfilter" value="" />
          <input type="hidden" name="display" value="2" />
          <input type="hidden" name="nav" value="all" />
          <input type="submit" name="Enter" value="Search" />
      </form>YaCy Search
  • Check all appearances of static IPs given in the code snippet and replace it with your own IP, or your host name
  • You may want to change the default text elements in the code snippet
  • To see all options for the search widget, look at the more generic description of search widgets at the configuration for live search.