Foswiki archived release

See Release Dates for the complete list of available releases.

Highlights of this maintenance release

• Contains 96 fixes relative to 2.1.0 (42 of which are enhancements)
• New release of JQuery
• Fixes several performance and security issues.

See ReleaseNotes02x01 for complete release notes.

For users

• Several performance fixes improves Foswiki's responsiveness.
• A user contributed WebSideBar toggle button can be enabled. This renders a small "hamburg" icon to restore the side bar when viewing Foswiki on a small device. See PatternSkinCssCookbookSidebarToggle.
• Several markup issues when using the Wysiwyg editor have been resolved.

For administrators:

• A new System.PendingRegistrations page shows registrations awaiting validation and/or approval.
• A potential major data loss issue was detected for sites upgrading from Foswiki 1.x related to Unicode DataForm field names. This release provides a workaround.
• Improvements in bootstrap for certain Nginx, Apache, and BSD platforms and configurations, and when running Foswiki behind a web proxy.
• Improvements in the Email configuration Wizard to better detect / support SSL Certificates.
• The {Sessions}{CookieRealm} now applies to more cookies resulting in better sharing between foswiki sites.

Translation status

As of this release,

• Chinese (Taiwan), French, Italian and Ukrainian are 100% complete.
• Danish and German 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.3.tgz	GPG	MD5	tar gz version of Foswiki
Foswiki-2.1.3.zip	GPG	MD5	zip version of Foswiki
Foswiki-2.1.3-vmware.7z2	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.3.tgz	GPG	MD5	upgrade tar gz version of Foswiki
Foswiki-upgrade-2.1.3.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

The Virtual Machine image was accidentally named with a 7z2 suffix. It is a 7z file, and can be renamed so that it will be automatically recognized.

https://github.com/foswiki/distro/releases/tag/FoswikiRelease02x01x03

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 FoswikiRelease02x01x03. 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.4

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

Id	Summary	Component	Current State
Item14324 7 years	Perl 5.25.10 reports unescaped left brace in regular expression errors. distro:61ca6a57acdd distro:32cfdf2b88ee distro:26d38fc13e35 distro:a615f9743e2a distro:919ca8d4bf17	PlatformPerl	Closed
Item14346 7 years	Systemd service file has issues, needs better documentation. distro:e002399716fb distro:b58575cac375 distro:5649b0a2fc4b distro:5bc31fdda515 distro:bbdbd84edc6b distro:80eefdfe0908 distro:7dc472f5fc01	FastCGIEngineContrib	Closed
Item14349 7 years	EditRowPlugin Edit Table button not functional on IE 11. distro:3f7c5f26e918 distro:d050b7cbd578 distro:0db156e0cfb1	EditRowPlugin	Closed
Item14366 7 years	=use CGI::Carp= in bin scripts BEGIN block cannot be found via Support.LocalLib.cfg override. distro:e7c23479e22c distro:8a9c3c4c43c8	PlatformPerl	Closed
Item14368 7 years	Failure to handle edge cases leads to obscure bug in RCS. distro:edfcc28e0a48 distro:a542eeaa7bd7 distro:8b85ec33b959 distro:999b73a21d9c distro:ee3a5bd1da3f distro:2b757626810b distro:f920be007364 distro:27d92f89efc1 distro:c4550f5dcb69 distro:78f56bd2b698	RCSStoreContrib	Closed
Item14372 7 years	JQueryPlugin ui-draggable got dropped from Config.spec. distro:9f183649bef6	JQueryPlugin	Closed
Item14388 7 years	NatEditPlugin does not honor the Support.ScriptSuffix setting, and doesn't accommodate short URLs. distro:17f1ed4da420	NatEditPlugin	Closed
Item14400 6 years	Configure settings leak into the global $Foswiki::cfg hash in fcgi environment distro:0324256d171b	Configure	Closed
Item14401 6 years	Foswiki crashes if Support.PageCache is enabled with missing dependencies distro:36956afc18f1 distro:01fd5e81b530	PageCache	Closed
Item14404 6 years	NatEdit Save and Continue action fails on mod_perl systems. distro:a3fb8a4664e0	NatEditPlugin	Closed
Item14405 6 years	Redirect after validation with HTTPS proxy for HTTP site results in unsafe redirect. distro:de3aafcb8c2c	FoswikiRequest	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.)

If upgrading from Foswiki 2.1.2 or earlier, all files in working/registration_approvals should be removed. Pending registrations will be lost.

Before upgrade, the pub/System/JQueryPlugin directory can be backed up and removed. A large number of the js and css files have been relocated. This optional step will clean up a number stale files.

If your site has configured the Expert {Sessions}{CookieRealm} setting, this release will now apply the realm to all of the cookies generated by Foswiki. This might require some users to clear their cookies for proper operation.

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

• If you have any DataForms using Unicode (non A-Za-z0-9) formfield names, you should enable the expert configuration setting: $Foswiki::cfg{LegacyFormfieldNames}
• 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 2017-02-12
• Publish date 2017-02-13
• Built from github commit e4f2c9d4a8