Installing XWiki Watch

Installing XWiki Watch 1.1 Milestone 1

This document contains the installation instructions for the latest version of XWiki Watch. You can find the installation instructions for the 1.0 version here.

Installing

Using the standalone package

• Download the XWiki Watch ZIP file from the download page.
• Unzip it and start the wiki (using start_xwiki.bat on windows systems and start_xwiki.sh on unix systems).

Using the Windows installer for standalone package

• Download the XWiki Watch .exe file from the download page, run it and follow the instructions.

Using the platform independent installer (the .jar installer) for standalone package

• Download the XWiki Watch .jar file from the download page. You need to have Java to be able to run the installer. Run the .jar file and follow the instructions: depending on your system settings you can do this either by double-clicking it or by explicitly invoking java -jar xwiki-watch-installer-generic-1.0.jar in a command line.

Installing the .war

• Download the XWiki Watch .war file and the XWiki Watch .xar files from the download page.
• The .war installation is similar to the .war installation for XWiki Enterprise, so please follow the instructions in the Enterprise installation guide, along with the prerequisites. After the last step, also install the XWiki Watch .xar.

XWiki Watch over an existing wiki

• You need to have XWiki Enterprise 1.5 (or one of the 1.5 releases) installed (you can download it from the download page).
• download the XWiki Watch XAR file
• download the XWiki Watch GWT client and GWT server jars
• In your server installation, copy the GWT client and GWT server jar files in the WEB-INF/lib folder.
• Change the web.xml file of your server installation (in the WEB-INF folder) to contain:

<servlet>
    <servlet-name>XWatchService</servlet-name>
    <servlet-class>com.xpn.xwiki.watch.server.XWatchServiceImpl</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>XWatchService</servlet-name>
    <url-pattern>/XWatchService</url-pattern>
  </servlet-mapping>

• (Re)Start the wiki and import the downloaded XAR in the wiki.
• In Administration > Preferences > Advanced, add WatchCode.Translations as an Internationalization Document Bundle.

Installing XWiki Watch 1.1 Milestone 1 xar on XWiki Enterprise 1.4

XWiki Enterprise 1.4.1 or 1.4.2

Installation is identical with installation for XWiki Enterprise 1.5.

XWiki Enterprise 1.4

If you are using a lower version of XWiki Enterprise (1.4 final or a 1.4 rc or one of the 1.4 milestones) but still want to run XWiki Watch 1.1 Milestone 1, you need to replace a couple of libraries in the XWiki Enterprise you are running. To enjoy the experience of XWiki Watch 1.1 M1 in XWiki enterprise 1.4, follow the next steps:

• get xwiki-web-gwt-1.5.1.jar from our maven repository
• go to webapps/xwiki/WEB-INF/lib folder in your XWiki Enterprise installation
• replace the xwiki-web-gwt-1.5-*.jar library (1.5-* corresponding to the version of enterprise you are running) with the jar you just downloaded
• restart your wiki
• install the XWiki Watch xar into your wiki following the instructions above, if you haven't already.
  Warning: If you are upgrading from an older version of XWiki Watch and you are using an XWiki Enterprise version lower than XWiki 1.4 milestone 2, because of this attachment import bug you will get an error while importing the XWiki Watch .xar. Delete the document Watch.GWT before importing the XWatch .xar. Don't forget to refresh the RSS Reader page after the import.

Building and installing an XWiki Watch Snapshot over an existing XWiki Enterprise

• Follow the general XWiki Building instructions about general guides & tools for getting and building XWiki sources (e.g. installing and configuring maven)
• Download XWatch sources from http://svn.xwiki.org/svnroot/xwiki/watch/trunk/
• Build the sources. You have two options here:
  • type mvn clean install in the parent project
  • go to gwt-client, gwt-server, wikis modules (in this order) and type mvn clean install in each of them
• Copy the jar files gwt-client/target and gwt-server/target in the WEB-INF/lib folder in your server installation
• Change the web.xml file of your server installation (in the WEB-INF folder) to contain:

<servlet>
    <servlet-name>XWatchService</servlet-name>
    <servlet-class>com.xpn.xwiki.watch.server.XWatchServiceImpl</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>XWatchService</servlet-name>
    <url-pattern>/XWatchService</url-pattern>
  </servlet-mapping>

• (Re)Start the wiki and import the .xar file in wikis/watch/targt in the wiki.
• In the Administration page, under Programming add WatchCode.Translations as an Internationalization Document Bundle (comma separated if there is already something in there).

Setting up

• For the Press Review email feature, set the SMTP server and admin email preferences in Administration > Preferences > Registration.

Setting up the database

The following indexes should be created on the XWatch tables (besides the indexes set on the XWiki regular tables -- see Database Administration), to optimize performance:

alter table feeds_feedentry add key (fee_feedurl(255)), add key (fee_flag), add key (fee_feedname(255)), add key (fee_date), add key (fee_read);
alter table feeds_feedentry add index (fee_title(255)), add index (fee_author(255)), add index (fee_category(255)), add index (fee_content(1024)), add index (fee_fullcontent(1024));
alter table feeds_aggregatorurl add key (agg_url(255)), add key (agg_name(255));
alter table feeds_aggregatorgroup add key (agg_name (255));
alter table feeds_aggregatorurlgroups add key (agl_value);
alter table feeds_feedentrytags add key (fet_value);
alter table feeds_keyword add key (key_name (255)), add key (key_group (255));