Skip to content

Commit

Permalink
Item13883: Update release notes for 2.1.3
Browse files Browse the repository at this point in the history
And add a bit of info on some page cache tuning.
  • Loading branch information
gac410 committed Feb 12, 2017
1 parent 4a76eef commit b9b4c48
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 10 deletions.
17 changes: 16 additions & 1 deletion core/data/System/PageCaching.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1459790135" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1486929101" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
---+!! Page Caching
How to get the best from HTML Caching.
Expand Down Expand Up @@ -360,6 +360,21 @@ Example:
This will add !MyOwnProtectedTopic to the set of default topics to be refreshed
on every change in the web it is in.

---++++ Controlling growth of topic dependencies table
By default, Foswiki will track every linked topic mentioned on a page as a dependency of
that page. This can result in very rapid growth of the cache dependencies
table, especially when the !WebLeftBar uses the =WEBLIST= macro, or links to a
large number of pages. These are tracked so that when a topic is added or
removed, the referencing pages will be refreshed to get the correct link to
the topic.

An optional (expert) configuration parameter ={Cache}{TrackInternalLinks}=
can be set to disable tracking these links for guests or for everyone. For
sites exposed to the Internet and search bot traffic, change this setting
from =on= to =authenticated= to ignore links in topics viewed by
guests. The setting =off= will disable all topic reference tracking, and is
_not_ recommended.

---++++ HTTP Compression
Modern browsers can decompress content encoded using gzip compression. You can
save a lot of network bandwidth by compressing pages, at the expense of some
Expand Down
6 changes: 3 additions & 3 deletions core/data/System/ReleaseHistory.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1486607275" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1486929101" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
History of Foswiki
%STARTINCLUDE%
Expand All @@ -8,9 +8,9 @@ History of Foswiki

%TOC%

---++ Foswiki Release 2.1.3-RC1 - 02 Feb 2017
---++ Foswiki Release 2.1.3 - 12 Feb 2017

Foswiki 2.1.3-RC1 was built on 02 Feb 2017. It is a release that contains 68 fixes and 21 enhancements.
Foswiki 2.1.3 was built on 12 Feb 2017. It is a release that contains 68 fixes and 21 enhancements.

---++ Foswiki Release 2.1.2 - 2 May 2016

Expand Down
36 changes: 30 additions & 6 deletions core/data/System/ReleaseNotes02x01.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1486607275" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1486929101" format="1.1" version="1"}%
%META:TOPICPARENT{name="ReleaseHistory"}%
---+!! Foswiki Release 2.1.3

Expand Down Expand Up @@ -54,7 +54,7 @@ Foswiki is released under the GNU General Public License.
* Foswiki 2.1.0 was built on 02 Feb 2016. It is a release that contains 37 fixes and 14 enhancements. It closes 7 Feature Requests.
* Foswiki 2.1.1 was built on 30 Apr 2016. It is a release that contains 36 fixes and 21 enhancements.
* Foswiki 2.1.2 was built on 2 May 2016. It is a release that contains 1 fix.
* Foswiki 2.1.3-RC1 was built on 08 Feb 2017. It is a release that contains 68 fixes and 21 enhancements.
* Foswiki 2.1.3 was built on 12 Feb 2017. It is a release that contains 68 fixes and 21 enhancements.


---++ Pre-installed Extensions
Expand Down Expand Up @@ -82,6 +82,12 @@ See [[%BUGS%/Item13696][Item13696]] for up-to-date details.

---++ Important changes in Foswiki 2.1.3

---+++ Security issues addressed in this release.

This release addresses 7 Severity 3 security vulnerabilities which are described in further detail
in [[https://foswiki.org/Support/SecurityAlert-XSSIssues-2017-0201][Support.SecurityAlert-XSSIssues-2017-0201]].
See [[https://foswiki.org/Development/SecurityAlertProcess][Security Alert Process]] for more details on how the Foswiki project handles security issues.

---+++ Possible data loss in DataForms

A possible data loss issue was discovered in DataForms migrated from Foswiki 1.x. A new configuration setting (={LegacyFormfieldNames}=) was added to restore the old Foswiki 1.x behavior.
Expand All @@ -105,9 +111,9 @@ See [[%BUGS%/Item14256][Item14256]] for more details.

---+++ Cookie changes

The optional configuration parameter ={Sessions}{CookieRealm}= now applies to all cookies generated by the Foswiki core. In addition, if your site is accessed
over HTTPS, all cooikes will now have the "Secure" flag set. In prior releases, only the Foswiki session cookie was covered. After upgrade to 2.1.3, users may
lose saved preferences if the cookie domain changes.
The optional (expert) configuration parameter ={Sessions}{CookieRealm}= now applies to the Domain of all cookies generated by the Foswiki core. In addition, if your site is accessed
over HTTPS, all cooikes will now have the =Secure= flag set. In prior releases, only the Foswiki session cookie used the =CookieRealm= and =Secure= flag. After upgrade to 2.1.3, users may
lose saved preferences and/or fail strikeone validation due to the cookie domain change. If using a non-default =CookieRealm= setting, users may need to delete all domain cookies after this update.

---+++ User Registration

Expand All @@ -124,10 +130,28 @@ Foswiki on a small device. See [[System.PatternSkinCssCookbookSidebarToggle]].

---+++ Configuration bootstrap

Bootstrap should be able to detect operation behind a proxy server, and will hopefully get the protocol (HTTP or HTTPS) and the hostname used by the user
Bootstrap should be able to detect operation behind a proxy server, and will try harder to get the protocol (HTTP or HTTPS) and the hostname used by the user
correct. If bootstrap fails to properly set up a proxy configuration, we would appreciate bug reports that will help us improve operation. Note that
operation behind a chain of multiple proxy servers is not currently detected.

---+++ Page cache tuning.

A new optional (expert) configuration parameter ={Cache}{TrackInternalLinks}=
is available for tuning how the cache tracks dependencies of topic references.
Default is =on= which is the same as prior releases. Foswiki will record
every topic link as a dependency. This can result in extrememly large cache
dependency tables, especially when using a WebLeftBar that displays a large
number of webs and/or topics.

Set this to =authenticated= to track these topic references only for logged in
users. Set to =off= (not recommended) to disable all reference link tracking.

The side effect of not tracking a link dependency is that cached pages will
not reflect updates that remove or add a topic.

Note that the PageCache should be globally flushed whenever any configuration
changes are made, or after updating Foswiki or any Extensions.

---+++ JQuery
This release updates to a newer maintenance version of JQuery. You should
visit =bin/configure= and select the updated versions of JQuery.
Expand Down

0 comments on commit b9b4c48

Please sign in to comment.