ReleaseNotesXWiki10

Last modified by Thomas Mortagne on 2017/03/24

Release Notes for XWiki 1.0

This is the final release of XWiki 1.0, following the release of XWiki 1.0 RC 5 last week. 

Invalid macro parameters used for the [toc] macro. Cause: [Failed to validate bean: [must be greater than or equal to 1]]. Click on this message for details.

Changes from 1.0 RC 5

There have been no changes since 1.0 RC 5. Actually XWiki 1.0 RC 5 has been promoted as XWiki 1.0. If you have been using XWiki 0.9 the full list of changes is the addition of all past release notes:

IMPORTANT: XWiki 1.0 RC 2 fixes an important security issue in past releases where passwords were stored in clear in the database. Passwords are now hashed. If you are upgrading from a previous version, any new user or any password update will automatically get the password hashed. However existing users who do not change their passwords will still have their passwords in clear in the database. Thus, we are providing a tool to automatically hash all passwords from an existing database. Start by backuping your wiki by doing an export or backuping your database. Then import that XAR into your wiki (be sure to be logged as an Admin) and then go to the Admin.CryptPasswords and follow the instructions there.

The complete list of changes since 0.9 can be found in JIRA

Known issues

  • Bugs we know about
  • Backlinks are used to find all the links to rename when renaming a page. However backlinks are saved when a page is saved thus it may happen that you don't have all backlinks generated with a clean XWiki database. In this special case, you can call the following in a page to refresh all links (you'll need to be admin to do this):
$xwiki.refreshLinks()

Migrating from versions prior or equal to XWiki 1.0 Beta 4

This is only for users using a custom web.xml file. We have changed slightly the way to configure XWiki in XWiki 1.0 Beta 5. Namely we have changed the way XWiki is initialized. Before, we were initializing Velocity by using the VelocityViewServlet in web.xml. This has been removed and we've added a InitializationServletContextListener class to perform all required XWiki initializations (right now we're only initializing Velocity). Thus if you've been using some version older than 1.0 Beta 5, you'll need to do the following if you wish to keep your web.xml (otherwise simply use the provided web.xml and skin this section):

  1. Remove the VelocityViewServlet from your web.xml
  2. Add the following 2 elements to your web.xml: context-param, listener. Here's an example:
<web-app>
...
 <description>XWiki Application</description>

 <!-- Define context level parameters for XWiki's initialization -->
 <context-param>
   <param-name>org.apache.velocity.properties</param-name>
   <param-value>/WEB-INF/velocity.properties</param-value>
   <description>Velocity's configuration</description>
 </context-param>

 <filter>
...
 </filter-mapping>

 <!-- XWiki's initialization is done in a Servlet Context Listener. This is where we set up
       everything that should be initialized prior to XWiki servicing requests. For example this
       is where we initialize Velocity. -->

 <listener>
   <listener-class>com.xpn.xwiki.web.InitializationServletContextListener</listener-class>
 </listener>

   <servlet>
...

In addition if you're upgrading an existing installation make sure you remove previous version of the Velocity JARs located in xwiki/WEB-INF/lib (Velocity and Velocity-Tools) and replace them with the new versions (Velocity 1.5 Beta 2 and Velocity-Tools 1.3) which can be found in the standalone distribution (the .exe or .tar.gz version)

Make sure you check the additional migration notes for the specific version you're migrating from below.

Migration from versions between 1.0 Beta 2 and 1.0 RC 3

  • Start by making a backup of your current database.
  • Plug your new XWiki install to point to your database.
  • Import the latest version of the Panels application to ensure you have the most up to date Panels in your wiki. Be careful that existing Panels which are also in the Panels Application will be overwritten (new Panels you have created won't be touched). Note that this is an optional step but recommended if you haven't upgraded to the latest XWiki version for a long time as there might be improvements in the Panels.

If you're migrating from a RC version you don't need to import the Default wiki XAR as no changes have been made to it

Migration from 1.0 Beta 1

  • Start by making a backup of your current database.
  • Plug your new XWiki install to point to your database.
  • In order to be able to let users switch from "simple" to "advanced" modes, you should import the new XWiki.XWikiUsers and XWiki.XWikiUserSheet pages in your wiki. You can do that by importing the full XAR and then selecting only that page to be imported in the Import tab of the Administration view.
  • You should also reimport the Panels Application since several bugs have been fixed.

Migration from 0.9.x versions

  • Start by making a backup of your current database.
  • Then there are 2 possible use cases:
    • You want to keep your existing skin. In that case, install the new version and point it to your existing database. If you were using the default skin you'll need to go the Administration page and replace the skin with "dodo" (this is the new name of the old default skin).
    • You want to use the new Albatross skin with your current database. In that case, install the new version and point it to your existing database. Then start XWiki and import the Panels XAR (this is required as the new skin makes use of them). Last, go to your wiki Administration page and in the skin section, enter "xwiki10b1".
  • In order to be able to let users switch from "simple" to "advanced" modes, you should import the new XWiki.XWikiUsers and XWiki.XWikiUserSheet pages in your wiki. You can do that by importing the full XAR and then selecting only that page to be imported in the Import tab of the Administration view.
  • See the installation guide for further migration instructions.

Contact us on the mailing list if you're experiencing any problem. Just make sure you have your current database backed up before you do anything.

Get Connected