Skip to content

Commit

Permalink
Item13883: Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
gac410 committed Jan 13, 2016
1 parent 87e113c commit a1c2d52
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
19 changes: 11 additions & 8 deletions core/data/System/InstallationGuide.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
%META:TOPICINFO{author="ProjectContributor" date="1448162210" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1452660011" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
<noautolink>
---+!! Installation Guide
Manually installing Foswiki
<div class='foswikiHelp' style='border:2px orange solid' >
This guide describes the steps for manually installing Foswiki, with __specific steps for installations on Linux with the Apache web server__.%BR%
This guide describes the steps for installing Foswiki, with __specific steps for installations on Linux with the Apache web server__.%BR%
If you would prefer to use a different web server, please refer to supplemental documentation when you reach the Apache-specific steps:
* *Nginx:* [[http://foswiki.org/Support/FoswikiOnNginx][Foswiki on Nginx]]
* *Lighttpd:* [[http://foswiki.org/Support/LighttpdBestPractice][Foswiki on Lighttpd]]
Expand All @@ -20,12 +19,11 @@ If you would prefer to use a different web server, please refer to supplemental

*Need help?* Visit Foswiki:Support web or Foswiki:Community.InternetRelayChat (irc.freenode.net, channel #foswiki).

This guide assumes a basic knowledge of server administration on the system being used. For more information, see Foswiki:System.AdminSkillsAssumptions.

---++ Before you start

* This guide assumes the a basic knowledge of server administration on the system being used. For more information, see Foswiki:System.AdminSkillsAssumptions.
* Review the [[#SystemRequirements][System Requirements]] (below) to make sure you have server prerequisites installed.
* Review the [[Foswiki:System.ReleaseNotes02x00][release notes]].
* If you need to install any Perl libraries from CPAN, see Foswiki:Support.HowToInstallCpanModules for more information.

---++ 5-Minute Install
Expand All @@ -41,6 +39,7 @@ Here's the quick version of the instructions, for *those that are already comfor
* =http<nop>://yoursite.com/bin/view=
* =http<nop>://yoursite.com/foswiki/bin/view=
1 Follow the link in the Bootstrap banner of the returned page to the bin/configure tool, address any warnings and save your configuration.
1 Return from configure (button at top of page), and register your first user.

That's it! You Foswiki should now be installed. Browse to =/bin/view= and start editing!

Expand Down Expand Up @@ -93,13 +92,13 @@ If you are running a Linux system with Perl found on the default path or are on

The easiest way to fix up the bin scripts is to run the =tools/rewriteshebang.pl= script: <verbatim class='bash'>
cd /path/to/foswiki/tools
perl -I ../lib rewriteshebang.pl</verbatim>
perl rewriteshebang.pl</verbatim>
or for Windows users: <verbatim class='bash'>
cd C:\path\to\foswiki\tools
perl -I ..\lib rewriteshebang.pl</verbatim>
perl rewriteshebang.pl</verbatim>
The script will determine the location of the Perl interpreter and will prompt to update both the bin and tools scripts in a single step. The changed files will be reported, and it is safe to rerun the script.

If you get an error about perl command not found, the you need to find where your perl command is installed and include that in your command. For example: <verbatim class='bash'>C:\path\to\perl -I ..\lib rewriteshebang.pl</verbatim>
If you get an error about perl command not found, the you need to find where your perl command is installed and include that in your command. For example: <verbatim class='bash'>C:\path\to\perl rewriteshebang.pl</verbatim>

<span id="Configure_the_web_server">
---+++ Step 4: Configure the web server
Expand Down Expand Up @@ -266,6 +265,10 @@ The default setup in Foswiki is that members of %IF{"$skin = 'plain'" then="<nop

To more easily debug access control issues, you may want to have a regular Foswiki user account for daily use, and a special one that belongs to the =AdminGroup= that you use only for administering your Foswiki site. See %IF{"$skin = 'plain'" then="<nop>System.<nop>AccessControls in your installation" else="$percntSYSTEMWEB$percnt.AccessControls"}% for more information on access controls and user groups.

<div class="foswikiHelp"> %T% Instead of adding users to the AdminGroup, grant those candidate administrators =ALLOWTOPICCHANGE= rights on the
AdminGroup. They can then use a button on the AdminGroup page to join or leave the group at will.
</div>

#WaysToProtectConfigure
---++++ Options to Protect the Configure Script
Foswiki 2.0 has changed how configure is protected. You no longer need to establish special protections within the web server configuration.
Expand Down
11 changes: 4 additions & 7 deletions core/data/System/UpgradeGuide.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1449190033" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1452660011" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
%STARTINCLUDE%
---+ Foswiki Upgrade Guide
Expand Down Expand Up @@ -146,12 +146,13 @@ If these steps are not done, users will have to clear their cache, or "shift-rel
*Review Foswiki:System.SystemRequirements* and *Install missing Perl modules using your local package manager or CPAN.* Foswiki 2.0 no longer ships with CPAN modules. If you have access to the command line on the server, you can test for missing dependencies by running: =perl tools/dependencies=

*Review the Release Notes and learn about the differences* between your old installation and the new release to which you are upgrading. Take note of any areas that affect your site and what special steps you may need to take.
* Foswiki:System.ReleaseNotes02x00 current release notes
* Foswiki:System.ReleaseNotes01x01 if upgrading from a release prior to Foswiki 1.1.9, _and_
* Foswiki:System.ReleaseNotes01x00 if upgrading from an older release of Foswiki 1.0.x

*Check that all the extensions (plugins, contribs, skins) used by your old installation are available with the new release.* Familiarize yourself with any new behaviour that you will have to adapt to or any configuration changes you will have to perform.

* *The !EditTablePlugin has been deprecated and is not shipped with Foswiki 2.0.* It is replaced by the EditRowPlugin. If you are upgrading an existing site, and have that plugin installed, only one of !EditTablePlugin or !EditRowPlugin should be enabled.
* *The !EditTablePlugin has been deprecated and is not enabled by default on Foswiki 2.0.* It is replaced by the EditRowPlugin. Only one of !EditTablePlugin or !EditRowPlugin should be enabled.
* *Review the deprecated jQuery javascript plugins.* The !JQueryPlugin has several changes in available jQuery !JavaScript plugins. Determine if any of these will impact your !JavaScript enabled topics.

*Choose the character encoding to be used in your site.*
Expand Down Expand Up @@ -188,7 +189,7 @@ You _must_ match the prior encoding, or convert old data to the new encoding if

---+++ Installation

*Follow the installation instructions in INSTALL.html*, located in the root of the new installation. *Install the new release in a new directory.* Do not install on top of the old release.
*Follow the installation instructions in INSTALL.html*, located in the root of the new installation, or online at Foswiki:System.InstallationGuide. *Install the new release in a new directory.* Do not install on top of the old release.
* For public or otherwise sensitive installations, ensure that your web server configuration is set to deny access to the new Foswiki installation for anyone except you.
* *Configure Foswiki* using the =configure= page.
* *(Not recommended!) If you are upgrading from an older Foswiki release*, first copy your =&lt;oldwiki&gt;/lib/LocalSite.cfg= file to =&lt;newwiki&gt;/lib/LocalSite.cfg= in order to preserve your existing configuration settings (Not recommended). Alternatively, you can reconfigure the new installation from scratch (you can use your old =LocalSite.cfg= file as a reference).
Expand All @@ -200,10 +201,6 @@ You _must_ match the prior encoding, or convert old data to the new encoding if
* Foswiki:Support.ApacheConfigGenerator
* Foswiki:Support.SettingFileAccessRightsLinuxUnix
* Foswiki:Support.UpgradingFromOlderTWikiReleases - upgrading TWiki from older TWiki releases
<!-- to be included once the supplemental documents are written (also modify the "Related Topics" section at the bottom of this document)
* Foswiki:Support.UpgradingFromTWiki4x2Releases - upgrading from TWiki4.2.X to Foswiki
* Foswiki:Support.UpgradingPatchReleases - upgrading releases where only last digit in the version changed
-->

Test your newly-installed Foswiki site and ensure that its basic functionality works: viewing and editing topics (you can try creating and editing a topic in the %SANDBOXWEB% web).

Expand Down

0 comments on commit a1c2d52

Please sign in to comment.