- From: Olivier Thereaux via cvs-syncmail <cvsmail@w3.org>
- Date: Wed, 30 Apr 2008 06:57:17 +0000
- To: www-validator-cvs@w3.org
Update of /sources/public/validator/htdocs/docs
In directory hutz:/tmp/cvs-serv24581/htdocs/docs
Modified Files:
install.html
Log Message:
Running through the installation process with a local guinea pig (karl),
and a few additions/fixes as a result.
Index: install.html
===================================================================
RCS file: /sources/public/validator/htdocs/docs/install.html,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -d -r1.34 -r1.35
--- install.html 30 Apr 2008 04:35:34 -0000 1.34
+++ install.html 30 Apr 2008 06:57:15 -0000 1.35
@@ -15,11 +15,14 @@
<li><a href="#otherguides">This guide, and other guides</a></li>
<li><a href="#install-fromsource">Install from source</a> (generic case)
<ul>
- <li><a href="#install-download">Download</a></li>
- <li><a href="#install-prereq">Prerequisites</a></li>
- <li><a href="#install-components">Install components</a></li>
- <li><a href="#install-configure">Configure</a></li>
- <li><a href="#install-check">Check the installation</a></li>
+ <li><a href="#install-prereq">Step 0: Prerequisites</a></li>
+ <li><a href="#install-prereq-sp">Step 1: install OpenSP, the SGML (and XML) parser</a></li>
+ <li <a href="#install-prereq-perl">Step 2: install required Perl Modules</a></li>
+ <li><a href="#install-download">Step 3: Download the validator and DTDs</a></li>
+ <li><a href="#install-components">Step 4: Unpack the validator</a></li>
+ <li><a href="#install-configure">Step 5: Configure the Validator</a></li>
+ <li><a href="#configure-apache">Step 6: Configure the Web server</a></li>
+ <li><a href="#install-check">Step 7: Check the installation</a></li>
</ul>
</li>
<li><a href="#install-troubleshoot">Installation troubleshooting</a></li>
@@ -84,10 +87,12 @@
<a href="http://sourceforge.net/projects/openjade/">OpenJade home page</a>.
Note that the validator will not work with any version of OpenSP earlier than 1.5.2.
</p>
- <p>If you install opensp from source, make sure to enable HTTP retrieval of DTDs:</p>
+ <p>If you install opensp from source, make sure to enable HTTP retrieval of DTDs.
+ Disabling the building of documentation </p>
+ <p>Run the following as root/administrator, or under sudo</p>
<pre>
[unpack opensp]
-./configure --enable-http
+./configure --enable-http --disable-docs-build
make
make install
</pre>
@@ -101,8 +106,9 @@
from CPAN. See the <a href="http://search.cpan.org/dist/Bundle-W3C-Validator/lib/Bundle/W3C/Validator.pm">documentation included with it</a>
for more details.
</p>
+ <p>Run the following as root/administrator, or under sudo</p>
<pre>
-sudo perl -MCPAN -e shell
+perl -MCPAN -e shell
[cpan shell starts, you may need to answer configuration questions]
install Bundle::W3C::Validator
</pre>
@@ -211,24 +217,26 @@
<code>share</code> from <code>validator-<em>X.X.X</em></code>
into <code>[validatorpath]</code>.
</p>
+<pre>
+# tar zxvf validator.tar.gz
+# tar zxvf sgml-lib.tar.gz
+# mkdir /usr/local/validator
+# cd validator-0.8.3
+# mv htdocs share httpd/cgi-bin /usr/local/validator
+</pre>
<p>
The <code>[validatorpath]</code> directory should now have
subdirectories named <code>cgi-bin</code>, <code>htdocs</code>,
and and <code>share</code>.
</p>
</li>
- <li>
- <p>The validator uses a number of configuration files, originally located under
- <code>[validatorpath]/htdocs/config</code>. On unix-based systems, we recommend
- to move all these files to the folder <code>/etc/w3c</code>.</p>
- </li>
</ol>
<h4 id="install-configure">Step 5: Configure the Validator</h4>
<ol>
<li>
<p>
- Create the directory <code>/etc/w3c</code> and copy a the files
+ Create the directory <code>/etc/w3c</code> and copy all the files
from <code>[validatorpath]/htdocs/config/</code> to it. You may keep
the configuration files in place, but would have to modify the Web
Server's environment variables to point to the configuration directory.
@@ -240,11 +248,32 @@
Edit <code>/etc/w3c/validator.conf</code> to reflect where files
are in your installation, and configure other parameters there as
you wish. This file is well commented and modifying it should be
- relatively straightforward. In general you will only need to check
+ relatively straightforward.
+ </p><p>In general you will only need to check
that the Base path is set to where you have unpacked the validator
- files.
+ files. If you have used <code>/usr/local/validator</code> you do not need
+ to change anything
</p>
+<pre>
+Base = /usr/local/validator
+</pre>
+ <p>If you plan to validate documents on a private network, you will need to enable
+ the following option in the <code>validator.conf</code> file:</p>
+<pre>
+Allow Private IPs = yes
+</pre>
+
</li>
+ <li><p>You may now test the validator script, before plugging it into the Web Server:</p>
+<pre>
+# cd /usr/local/validator/
+# cd cgi-bin/
+# ./check uri=http://www.w3.org/
+…
+</pre>
+<p>The script should output the raw HTML results of validation. If this does not work, double-check that
+ you have properly followed all the steps so far.</p>
+</li>
</ol>
<h5>For reference: list of configuration files</h5>
<p><strong>You may skip this, unless you plan to modify the validator's default behavior.</strong>.</p>
@@ -275,7 +304,7 @@
</dl>
- <h4 id="configure-apache">Step 6: Configure the Web server</h5>
+ <h4 id="configure-apache">Step 6: Configure the Web server</h4>
<p>The following instructions are for the Apache Web server, and should be adapted
if you plan on using another server.</p>
<ol>
Received on Wednesday, 30 April 2008 06:57:48 UTC