Item13883: Add some docs on checking the installation

foswiki · May 10, 2017 · 1772f30 · 1772f30
1 parent 94f3f47
commit 1772f30
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/core/data/System/InstallationGuide.txt b/core/data/System/InstallationGuide.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1490124221" format="1.1"  version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1494206626" format="1.1"  version="1"}%
 %META:TOPICPARENT{name="AdminDocumentationCategory"}%
 <noautolink>
 ---+!! Installation Guide
@@ -412,6 +412,12 @@ And the configuration can then be checked, with optional verbose output:
 <verbatim class='bash'>
 tools/configure -check -verbose</verbatim>
 
+File system permissions can also be checked for any of
+={DataDir}=, ={LocalesDir}=, ={PubDir}=, ={ScriptDir}=, ={TemplateDir}=, ={ToolsDir}= and ={WorkingDir}=, for ex:
+<verbatim>
+tools/configure -check {DataDir} -method validate_permissions</verbatim>
+
+
 Configuration settings can be searched and queried as well:
 <verbatim class='bash'>
 tools/configure -search Umask

diff --git a/core/data/System/UpgradeGuide.txt b/core/data/System/UpgradeGuide.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="" date="1494199312" format="1.1"  version="1"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1494206626" format="1.1"  version="1"}%
 %META:TOPICPARENT{name="AdminDocumentationCategory"}%
 %STARTINCLUDE%
 ---+ Foswiki Upgrade Guide
@@ -413,6 +413,18 @@ In your new installation, default copies of the following topics were installed:
 
 If you customized these topics in your old installation, transfer the changes to these topics in the new installation. Use the corresponding files in the =&lt;oldwiki&gt;/&lt;old_system_web&gt;/= directory as a reference.
 
+---+++ Check your configuration and installation
+Configure provides some tools to validate your installation.  They should be
+run as the web server userid:
+<verbatim>
+cd <path-to-foswiki-installation>
+sudo -u www-data tools/configure -check
+sudo -u www-data perl tools/configure -check {DataDir} -method validate_permissions
+sudo -u www-data perl tools/configure -check {PubDir} -method validate_permissions
+ ...  also can be run on: 
+    {LocalesDir} {ScriptDir}  {TemplateDir} {ToolsDir} {WorkingDir}
+</verbatim>
+
 ---+++ Validate your Wiki applications and other key functionality
 
 Execute your test plan to validate the Wiki applications and other key functionality that need to be up and running after the upgrade.