Installing XWiki Watch 1.0

Last modified by Thomas Mortagne on 2023/10/10 14:36

Installing

XWiki Watch over an existing wiki (installing the .xar)

  • You need to have XWiki 1.4.1 (or one of the 1.5 releases) installed (you can download it from the download page).
  • Download the XWiki Watch XAR file.
  • Start the wiki and import the downloaded XAR in the wiki.
  • In "Administration > Preferences > Advanced", add WatchCode.Translations as an Internationalization Document Bundle.

Your XWiki Watch installation is now ready, just access the Watch space and enjoy the collaborative experience!

If you do not have XWiki 1.4.1 nor can/wish to install it but still want to enjoy XWiki Watch 1.0, check out Installing XWiki Watch 1.0 on XE 1.4 or Installing XWiki Watch 1.0 on XE 1.3 for details on how you can do that.

Using the standalone package

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

Your XWiki Watch installation is now ready, just access the Watch space and enjoy the collaborative experience!

You can log in using the default Admin user (first letter is capitalized). The default password is 'admin' (lowercase).

Using the Windows installer for standalone package

Your XWiki Watch installation is now ready, just access the Watch space and enjoy the collaborative experience!

You can log in using the default Admin user (first letter is capitalized). The default password is 'admin' (lowercase).

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

  • Download the XWiki Watch .jar file.
  • Run the .jar file (You need to have Java to be able to run the installer) 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.

Your XWiki Watch installation is now ready, just access the Watch space and enjoy the collaborative experience!

You can log in using the default Admin user (first letter is capitalized). The default password is 'admin' (lowercase).

Installing XWiki Watch 1.0 on XWiki 1.4

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

  • get xwiki-web-gwt-1.4.1.jar from our maven repository
  • go to webapps/xwiki/WEB-INF/lib folder in your XWiki installation
  • replace the xwiki-web-gwt-1.4-*.jar library (1.4-* corresponding to the version of XWiki you are running) with the jar you just downloaded
  • restart your wiki
  • install the xwiki-watch-1.0.xar into your wiki following the instructions above, if you haven't already. If you are upgrading from an older version of XWiki Watch and you are using an XWiki 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.

Your XWiki Watch installation is now ready, just access the Watch space and enjoy the collaborative experience!

Installing XWiki Watch 1.0 on XWiki 1.3

If you have a lower version of XWiki but still want to run XWiki Watch 1.0, you need to replace a couple of libraries in the XWiki you are running. Note that this will upgrade the XWiki GWT API in your installation to the 1.4.1 version, which uses GWT-1.4.61 instead of 1.3.3. If you have developed your own applications on top of XWiki that use GWT and / or the XWiki GWT API and they are not compatible with GWT 1.4.61, you should not do this.

To enjoy the experience of XWiki Watch 1.0 in XWiki 1.3, follow the next steps:

  • get xwiki-web-gwt-1.4.1.jar from our maven repository
  • get gwt-servlet-1.4.61.jar from gwt maven repository
  • go to webapps/xwiki/WEB-INF/lib folder in your XWiki installation
  • remove the gwt-servlet-1.3.3.jar and xwiki-web-gwt-1.3.x.jar libraries (1.3.x corresponding to the version of XWiki you are running). 
  • copy the two jars you just downloaded to this folder
  • restart your wiki
  • install the xwiki-watch-1.0.xar into your wiki following the instructions above, if you haven't already. If you are upgrading from an older version of XWiki Watch, 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.

Your XWiki Watch installation is now ready, just access the Watch space and enjoy the collaborative experience!

Setting up

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

Get Connected