update deployment guide
diff --git a/src/overview.html b/src/overview.html
index f919d99..9675556 100644
--- a/src/overview.html
+++ b/src/overview.html
@@ -1,5 +1,5 @@
-<html>
<body>
+
<h3>Table Of Contents</h3>
<li><a href="#spadaptor">SharePoint Adaptor</a></li>
<li><a href="#spuserprofileadaptor">SharePoint User Profile Adaptor</a></li>
@@ -24,19 +24,17 @@
<ol>
<li>Add the IP address of the computer that hosts the adaptor to the <b>List
of Trusted IP Addresses</b> on the GSA.
- <p>In the GSA's Admin Console, go to <b>Crawl and Index > Feeds</b>,
+ <p>In the GSA's Admin Console, go to <b>Content Sources > Feeds</b>,
and scroll down to <b>List of Trusted IP Addresses</b>. Add the IP address
for the adaptor to the list.
- <li>Add the URLs provided by the adaptor to the <b>Follow and Crawl Only
- URLs with the Following Patterns</b> on the GSA.
- <p>In the Admin console, go to <b>Crawl And Index > Crawl URLs</b>, and
- scroll down to <b>Follow and Crawl Only URLs with the Following
- Patterns</b>. Add an entry like <code>http://adaptor.example.com:5678/doc/
+ <li>Add the URLs provided by the adaptor to the <b>Follow Patterns</b> on the GSA.
+ <p>In the Admin console, go to <b>Content Sources > Web Crawl >
+ Start and Block URLs</b>, and scroll down to <b>Follow Patterns</b>.
+ Add an entry like <code>http://adaptor.example.com:5678/doc/
</code> where <code>adaptor.example.com</code> is the hostname of the
machine that hosts the adaptor. By default the adaptor runs on port 5678.
</ol>
-
<h4>Configure Adaptor</h4>
<ol>
<li>Create a file named <code>adaptor-config.properties</code> in the
@@ -53,7 +51,8 @@
<li>Create a file named <code>logging.properties</code> in the same directory
that contains logging configuration:
- <pre>level=INFO
+ <pre>
+.level=INFO
handlers=java.util.logging.FileHandler,java.util.logging.ConsoleHandler
java.util.logging.FileHandler.formatter=com.google.enterprise.adaptor.CustomFormatter
java.util.logging.FileHandler.pattern=adaptor.%g.log
@@ -64,6 +63,40 @@
<li>Run the adaptor using cmd.exe:
<pre>java -Djava.util.logging.config.file=logging.properties -jar adaptor-sharepoint-YYYYMMDD-withlib.jar</pre>
</ol>
+
+<!--
+<h4>Running as service on Windows</h4>
+ <p>Example execution with jsvc:
+ <pre>jsvc -pidfile adaptor.pid -cp adaptor-sharepoint-YYYYMMDD-withlib.jar com.google.enterprise.adaptor.Daemon com.google.enterprise.adaptor.sharepoint.SharePointAdaptor</pre>
+-->
+
+<h4>Optional <code>adaptor-config.properties</code> fields</h4>
+<dl>
+ <dt>
+ <code>sharepoint.xmlValidation</code>
+ </dt>
+ <dd>
+ Whether to enable strict checking of XML
+ responses using the expected schema.
+ Defaults to false.
+ </dd>
+ <dt>
+ <code>sharepoint.maxIndexableSize</code>
+ </dt>
+ <dd>
+ Number of bytes of a document that GSA indexes. Defaults to 2097152.
+ </dd>
+ <dt>
+ <dt>
+ <code>adaptor.namespace</code>
+ </dt>
+ <dd>
+ Namespace used for ACLs sent to GSA. Defaults to "Default".
+ </dd>
+</dl>
+
+<br>
+<!-- SPUP -->
<h3 id="spuserprofileadaptor">Adaptor for SharePoint User Profiles Deployment</h3>
<p>Each adaptor instance is only able to support one User Profile Service
@@ -85,19 +118,17 @@
<ol>
<li>Add the IP address of the computer that hosts the adaptor to the <b>List
of Trusted IP Addresses</b> on the GSA.
- <p>In the GSA's Admin Console, go to <b>Crawl and Index > Feeds</b>,
+ <p>In the GSA's Admin Console, go to <b>Content Sources > Feeds</b>,
and scroll down to <b>List of Trusted IP Addresses</b>. Add the IP address
for the adaptor to the list.
- <li>Add the URLs provided by the adaptor to the <b>Follow and Crawl Only
- URLs with the Following Patterns</b> on the GSA.
- <p>In the Admin console, go to <b>Crawl And Index > Crawl URLs</b>, and
- scroll down to <b>Follow and Crawl Only URLs with the Following
- Patterns</b>. Add an entry like <code>http://adaptor.example.com:5678/doc/
+ <li>Add the URLs provided by the adaptor to the <b>Follow Patterns</b> on the GSA.
+ <p>In the Admin console, go to <b>Content Sources > Web Crawl >
+ Start and Block URLs</b>, and scroll down to <b>Follow Patterns</b>.
+ Add an entry like <code>http://adaptor.example.com:5678/doc/
</code> where <code>adaptor.example.com</code> is the hostname of the
machine that hosts the adaptor. By default the adaptor runs on port 5678.
</ol>
-
<h4>Configure Adaptor</h4>
<ol>
<li>Create a file named <code>adaptor-config.properties</code> in the
@@ -114,7 +145,8 @@
<li>Create a file named <code>logging.properties</code> in the same directory
that contains logging configuration:
- <pre>level=INFO
+ <pre>
+ .level=INFO
handlers=java.util.logging.FileHandler,java.util.logging.ConsoleHandler
java.util.logging.FileHandler.formatter=com.google.enterprise.adaptor.CustomFormatter
java.util.logging.FileHandler.pattern=adaptor.%g.log
@@ -125,5 +157,35 @@
<li>Run the adaptor using cmd.exe:
<pre>java -Djava.util.logging.config.file=logging.properties -jar adaptor-sharepoint-user-profile-YYYYMMDD-withlib.jar</pre>
</ol>
+
+<!--
+<h4>Running as service on Windows</h4>
+ <p>Example execution with jsvc:
+ <pre>jsvc -pidfile adaptor.pid -cp adaptor-sharepoint-user-profile-YYYYMMDD-withlib.jar com.google.enterprise.adaptor.Daemon com.google.enterprise.adaptor.sharepoint.SharePointUserProfileAdaptor</pre>
+-->
+
+<h4>Optional <code>adaptor-config.properties</code> fields</h4>
+<dl>
+ <dt>
+ <code>profile.setacl</code>
+ </dt>
+ <dd>
+ Whether user profile information is considered restricted
+ or public. Defaults to true.
+ </dd>
+ <dt>
+ <code>profile.mysitehost</code>
+ </dt>
+ <dd>
+ Defaults to virtual server.
+ </dd>
+ <dt>
+ <dt>
+ <code>adaptor.namespace</code>
+ </dt>
+ <dd>
+ Namespace used for ACLs sent to GSA. Defaults to "Default".
+ </dd>
+</dl>
+
</body>
-</html>
