Supplemental Documents

Many of the not yet created documents will be created in a near future based on existing old documents. Yes you can help creating them! But please rewrite the docs as most of the old docs are nothing but a cloud of tag smoke and searches.

Release information

• KnownIssues - Index of known issues for each release

Setup

Installation

• InstallingOnSpecificPlatforms
• InstallingOnSharedHosts

• Installation of the Foswiki virtual machine image / software appliance

Upgrading

• JQueryMigrationGuide - upgrading between Foswiki JQuery releases
• UpgradingFromTWiki4x2Releases - upgrading from TWiki4.2.X to Foswiki
• UpgradingFromOlderTWikiReleases - upgrading Foswiki from older TWiki releases
• UpgradingPatchReleases - upgrading releases where only last digit in the version changed

Configuration

Web server

• ApacheConfigGenerator - Generates an Apache config file
• LighttpdBestPractice - setting up a lighttpd foswiki server
• ShorterUrlCookbook - how to make the URL nicer and short

Operating system

• SettingFileAccessRightsLinuxUnix - set up the right file access permissions for an installation under Unix/Unix-like systems (including Linux)
• HowToInstallCpanModules - An introduction to installing CPAN libraries
• HowToUseFoswikiWithLocalPerlInstallation - A general description for non-root Foswiki installations using a separated local perl installation

Localization

• InternationalizationSupplement - configure I18N and localization

Performance

• PerformanceSupplement - improve performance

Security

• SecuringYourSite - Overview of what is needed to install a secure site
• ProtectingYourConfiguration - Important instruction to the installer how to secure the important and vulnerable bin/configure script.
• UserAuthenticationSupplement - topics that describe different ways to setup authentication.

Administration

• AdministratorsCookBook - Misc hints for the administrator
• SecurityFeatures - overview guide to Foswiki security
• CronWizard - helps to set up periodic scripts on Unix/Linux
• IntegrateGeneratedContent - notes on integrating content generated by custom scripts

Extensions

• PluginsSupplement
• SkinsSupplement

this is for now a placeholder document pointing to mostly not yet created docs - but it had to be created so we can link to it from the documents we are Rebranding. Could not wait for a decision any longer and it seemed the wind was blowing towards the Support web. Kenneth will port over these documents the next month -- Kenneth Lavrsen

---

Should be cross-referenced (or even merged?) with DocumentationTaskTeamProjectIdeas so that we do not do the work twice. IMO the documents listed here apply for Administrator users.

-- SebastianKlus - 18 Nov 2008 - 02:58

We agreed to have these helper topics in Support. And SupplementalDocuments is referred to from quite a lot of documentation in both the core documentation and in many many plugins. I have spent many many many hours checking doc update in to SVN in more than 100 checkins updating more than 500 individual documents where I have been getting the links changed and I do not want to do it all over again.

This topic an index topic of the Support documents that mainly admins need for installing, upgrading etc. It was a major important resource on twiki.org and will continue to be here. On TWiki.org they were hard to find hidden inside the TWiki web. Here on Foswiki they need to be among the first things you find when you enter the support web.

The installation docs that come with the downloaded package has quite many references to these SupplementalDocuments. And we refer to them all the time when people ask support questions on IRC.

For all the links above I have content that just needs to be refactored a little from their t.o versions. And I plan to do that soon. As you can see I have already created some of the more urgent. I will not be moving all the SupplementalDocuments over from t.o because many of them were just useless searches and tag clouds. The ones I have listed here are the good ones that have actual content.

Under InstallingOnSpecificPlatforms there will be a number of documents that specify how to install on specific targets like debian and Red Hat.

-- KennethLavrsen - 18 Nov 2008 - 15:46