Foswiki archived release

See Release Dates for the complete list of available releases.

Highlights of this release

• Contains 37 fixes and 14 enhancements
• Implements 7 new features.
  • New "concatenate" feature allows incremental building of complex macros.
  • Attachment names allow embedded spaces without renaming.
• Improved international character set support.

See ReleaseNotes02x01 for complete release notes.

For administrators:

• New user registration topic features:
  • Simplified tailoring
  • Support for multiple custom registration topics with custom new user topic templates.

Foswiki 2.1.0 has an upgrade package available which can be used to upgrade in-place from a Foswiki 2.0.x system.

Translation status

As of this release,

• French, German, Italian, Traditional Chinese and Ukrainian are 100% complete.
• Czech, Danish are >95% complete.

For more details on translation status, see Foswiki:Community.TranslationTeam and Foswiki's Weblate translation server. Foswiki is now using continuous translation, so contributions at any time are very helpful. Foswiki thanks the Translators for their Herculean efforts. If you are interesting in helping with the translation, please contact foswiki-translations@lists.sourceforge.net.

Download

GPG Signatures and MD5 checksums are provided for verifying the integrity of the files for the primary download packages.

File	GPG	MD5	Description
Foswiki-2.1.0.tgz	GPG	MD5	tar gz version of Foswiki
Foswiki-2.1.0.zip	GPG	MD5	zip version of Foswiki
Foswiki-2.1.0-vmware.zip	GPG	MD5	VM Image (instructions)

Upgrade packages

These packages can be used to upgrade Foswiki Release 2.0.0 or newer. See #Upgrade_Instructions for further information

Upgrade packages must not be used to upgrade older releases.

File	GPG	MD5	Description
Foswiki-upgrade-2.1.0.tgz	GPG	MD5	upgrade tar gz version of Foswiki
Foswiki-upgrade-2.1.0.zip	GPG	MD5	upgrade zip version of Foswiki

%STARTSECTION{"download-none"}%
<blockquote class="foswikiAlert"> *This release has not been built yet!*  This is a draft of the release announcement.  If you want an early start to testing, see Development.GitBasedInstall.</blockquote>
%ENDSECTION{"download-none"}%

%STARTSECTION{"download-topic"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="%PUBURLPATH%/%BASEWEB%/%BASETOPIC%"
  upgraded=""
  upgrade=""
}%
%ENDSECTION{"download-topic"}%

%STARTSECTION{"download-topic-upgrade"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="%PUBURLPATH%/%BASEWEB%/%BASETOPIC%"
  upgraded="upgrade-"
  upgrade="upgrade"
}%
%ENDSECTION{"download-topic-upgrade"}%

%STARTSECTION{"download-sourceforge"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="http://sourceforge.net/projects/foswiki/files/foswiki/%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  upgraded=""
  upgrade=""
}%
%ENDSECTION{"download-sourceforge"}%

%STARTSECTION{"download-sourceforge-upgrade"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="http://sourceforge.net/projects/foswiki/files/foswiki/%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  upgraded="upgrade-"
  upgrade="upgrade"
}%
%ENDSECTION{"download-sourceforge-upgrade"}%

%STARTSECTION{"download-github"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="https://github.com/foswiki/distro/releases/download/%FORMFIELD{"ReleaseTag" topic="%BASETOPIC%"}%"
  upgraded=""
  upgrade=""
}%
%ENDSECTION{"download-github"}%

%STARTSECTION{"download-github-upgrade"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="https://github.com/foswiki/distro/releases/download/%FORMFIELD{"ReleaseTag" topic="%BASETOPIC%"}%"
  upgraded="upgrade-"
  upgrade="upgrade"
}%
%ENDSECTION{"download-github-upgrade"}%

%STARTSECTION{"download"}%
%TABLE{sort="off"}%
| *File* | *GPG* | *MD5* | *Description* |
| [[%url%/Foswiki-%upgraded%%release%.tgz][%ICON{download}% Foswiki-%upgraded%%release%.tgz]] | [[%url%/Foswiki-%upgraded%%release%.tgz.asc][GPG]] | [[%url%/Foswiki-%release%.md5][MD5]] | %upgrade% tar gz version of Foswiki |
| [[%url%/Foswiki-%upgraded%%release%.zip][%ICON{download}% Foswiki-%upgraded%%release%.zip]] | [[%url%/Foswiki-%upgraded%%release%.zip.asc][GPG]] | [[%url%/Foswiki-%release%.md5][MD5]] | %upgrade% zip version of Foswiki |%IF{"'%upgraded%'='' and '%FORMFIELD{"VMImage" topic="%BASETOPIC%"}%'='1'" then="
| [[%url%/Foswiki-%release%-vmware.%FORMFIELD{"VMFormat" topic="%BASETOPIC%"}%][%ICON{download}% Foswiki-%release%-vmware.%FORMFIELD{"VMFormat" topic="%BASETOPIC%"}%]] | [[%url%/Foswiki-%release%-vmware.%FORMFIELD{"VMFormat" topic="%BASETOPIC%"}%.asc][GPG]] | [[%url%/Foswiki-%release%-vmware.md5][MD5]] | [[Support.VirtualMachineImages][VM Image (instructions)]] |"}%%ENDSECTION{"download"}%

%STARTSECTION{"upgrade-header"}%
---++ Upgrade packages

%IF{"'%BASETOPIC%'/UpgradeFrom=''" 
   else="These packages can be used to upgrade __Foswiki Release %FORMFIELD{"UpgradeFrom" topic="%BASETOPIC%"}% or newer__. See [[#Upgrade_Instructions]] for further information"
   then="If you already have an earlier version of Foswiki %FORMFIELD{"ReleaseMajor" topic="%BASETOPIC%"}%.%FORMFIELD{"ReleaseMinor" topic="%BASETOPIC%"}%.X installed, you can extract an upgrade package on top of the installation. The =major.minor= part of the release should not be changed by an upgrade package."}%

%X% Upgrade packages must not be used to upgrade older releases.

%ENDSECTION{"upgrade-header"}%

Other downloads/installers

This release can also be downloaded from https://github.com/foswiki/distro/releases/tag/FoswikiRelease02x01x00

Getting help & providing feedback

Don't forget to use the upgrade or installation guides. If you need help, there are several options:

• The IRC channel
• foswiki-discuss mailing list
• Support forum
• Paid support

We want to hear from you! Especially if you have noticed a bug, have some ideas we could use, or just want to contribute:

• File a new task for bug reports
• Create, review or comment on feature proposals to help influence the future of Foswiki
• Chat with other users, developers, translators, and testers on our friendly IRC channel
• If E-mail is more your thing, try our foswiki-discuss mailing list

Known issues

The following issues have been reported against FoswikiRelease02x01x00. Tasks in "Closed" or "Waiting for Release" state will be fixed in the next release.

Major issues of Foswiki, to be fixed in: 2.1.1

The following "urgent" issues have been marked for resolution in Foswiki 2.1.1

Id	Summary	Component	Current State
Item13795 9 years	Redundant url params generated by %SCRIPTURLPATH macro. distro:dd522e5f0689 distro:5603c4423c15 distro:c1e39f2707d9 distro:d022e277ab0a		Closed
Item13941 8 years	%EDITTABLE macro visible in print mode. distro:cbcf4b727b34 distro:f106e910299a distro:60ee4cd387e2	EditRowPlugin	Closed
Item13944 8 years	Foswiki::Func::addToHEAD (deprecated in 2010) breaks with Foswiki 2.1 Zones rewrite. distro:7c038d0bcc90	FoswikiFunc	Closed
Item13957 8 years	TinyMCEPlugin does not handle indent correctly. distro:15bdc5182136 distro:e09d7302d95c distro:d1428a2562ec	TinyMCEPlugin	Closed
Item13958 8 years	The indent feature with colon does not render an empty line. distro:15bdc5182136 distro:e09d7302d95c distro:d1428a2562ec	FoswikiRender	Closed
Item13995 8 years	Search $changes renders a simple summary. distro:8c46a18bb4e2 distro:4379bceb6ef2	SEARCH	Closed
Item14004 8 years	EditRowPlugin textarea doesn't honor the dimensions. distro:29f9fec57b89 distro:61df8e97e897 distro:eb3601f43352 distro:78cc12d7892a	EditRowPlugin	Closed
Item14011 8 years	Make sure HTTP2 is always compressing HTML. distro:8a048daee758 distro:ff78a399d3f8 distro:50fa62638a64 distro:3e71d41f7622 distro:e029102065e6 distro:866454f37dc8 distro:bfbc24dcc1a3 distro:5c7eb90273e8		Closed
Item14014 8 years	Comment plugin unable to use template files in hierarchical webs in Foswiki 2.1. distro:2535fd34da96 distro:e49ed4bfbb86	FoswikiTemplates	Closed
Item14024 8 years	JQueryPlugin (v6.32) might not initialise correctly with current JSON (v2.90) / JSON-XS (v3.02) modules w/o allow_nonref. distro:6a952f501a96 distro:819775b5719e distro:18f827ebcc1b	JQueryPlugin, ModPerlEngineContrib	Closed
Item14025 8 years	JsonRpcContrib requires allow_nonref (when using JSON-XS v3.02). distro:6a952f501a96 distro:819775b5719e distro:18f827ebcc1b	JsonRpcContrib, ModPerlEngineContrib	Closed
Item14035 8 years	Plain file logger fails to rotate the log. distro:649bc067a7fe distro:c01c51ed387c distro:2a17ac104f4b	FoswikiLogger	Closed
Item14037 8 years	PageCache needs an index on the to_topic field. distro:8dc53bd0f578 distro:790c4d37b2fb	PageCache, Performance	Closed
Item14050 8 years	topic Support.WikiSyntax missing distro:2f5c2c0be45a distro:553e04733d13	Documentation	Closed
Item14051 8 years	regression: page cache does not respect host url anymore distro:ede4259620f1 distro:06da0433f775	PageCache	Closed

Installation

Please refer to the INSTALL.html which can be found the downloaded tgz/zip. It can be also found on Foswiki.org in the System.InstallationGuide

Upgrade Instructions

• See System.UpgradeGuide for details on upgrading from older versions of Foswiki
• See System.SystemRequirements for the latest System Requirements.
• Be sure to take a backup!
• The upgrade packages excludes files "commonly" modified, for example, WebHome, WebPreferences, AdminGroup, etc. If your installation has modified other topics, or template files, those updates will be lost!
• If you use tar, then you can extract the upgrade package on top of your installation by using: (Be sure to run this as your web server user to avoid changing file ownership.)

cd /var/www/foswiki
tar --strip-components=1 -zxf /path/to/Foswiki-upgrade-2.x.x.tgz
cd tools
./configure --save

• Similarly, if you are using the zip upgrade package, then

cd /var/www/foswiki
unzip -o /path/to/Foswiki-upgrade-2.x.x.zip
cd tools
./configure --save

• After upgrade, restart the web server, clear the foswiki page cache, clear your browser cache.
• If things are not fully working, verify file system permissions and ownership. See System.InstallationGuide#Step_2:_Confirm_file_and_directory_ownership_and_permissions

If upgrading from Foswiki 2.0.0, all working/tmp/cgisess_* files must be deleted. All users will have to log in after the upgrade. (This change was introduced in Foswiki 2.0.1.)

After upgrading from Foswiki 2.0.x, you should visit configure, enable "Expert" options, and visit the Security and Authentication > Environment tab, and "Reset" the "Name Filter" and "Upload Filter" to their default settings, in order to apply updated defaults.

The following files may be removed after upgrading from Foswiki 2.0.x to Foswiki 2.1.0:

• pub/System/UserRegistration/js.js
• pub/System/DefaultUserRegistration/validate.js
• ReleaseNotes02x00.html

Upgrading from Foswiki 1.x.

Caution:There are a number of significant changes that require action before migrating data from release 1.0 and 1.1. Carefully review the release notes for ReleaseNotes02x00

• JavaScript is now required for many operations.
• New default PlainFileStore cannot coexist with existing RCS revision files. If new store is selected, a conversion script must be run.
• Foswiki now defaults to utf-8, Before importing data, you must either match previous encoding, or convert the data from the old store to the new character encoding.
• Empty DENY rules must be changed to ALLOW * wildcards. Or the old feature must be enabled in the configuration.
• Sessions now use IP Matching by default. If your site supports roaming / mobile users or is behind a proxy, this must be disabled.
• Installation process has changed. Do not visit bin/configure as your first URL. Go directly to your default view url and then follow the link to configure.
• Foswiki no longer ships with CPAN perl modules. Install CPAN prerequisites using your local system package manager, cpanm, or CpanContrib
• Perl 5.8.8 is the minimum perl release. Perl 5.20 or higher is recommended for best performance.
• Foswiki now predominantly uses 'single quotes' in generated HTML, and "double quotes" in macros. The change to singe quotes in generated HTML may require some rework of Foswiki macros.
• Some versions of CGI should be avoided (especially 4.10-4.13) to prevent corruption of international characters in topics when utf-8 is enabled.

License

• This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
• This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
• See the GNU General Public License for more details, published at http://www.gnu.org/copyleft/gpl.html

Release Details

• Build date 2016-02-03
• Publish date 2016-02-03
• Built from github commit 1c076514e7