blob: 1935d33f620104374389d7ae901d62a4c865c3f8 [file] [log] [blame]
<h3 id="fsadaptor">Deployment of File System Adaptor</h3>
<p>A single instance of File System adaptor can have
GSA index a single UNC share. DFS is supported.
<li>GSA 7.2 or higher
<li>Java JRE 1.7 or higher installed on computer that runs adaptor
<li>File System Adaptor JAR executable
<li>Credentials for File System share to be indexed by GSA
<li>Requires running on Microsoft Windows
<h4>Configure GSA for Adaptor</h4>
<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>Content Sources &gt; 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 Patterns</b>
on the GSA.
<p>In the Admin console, go to <b>Content Sources &gt; Web Crawl
&gt; Start and Block URLs</b>, and
scroll down to <b>Follow Patterns</b>.
Add an entry like <code>
</code> where <code></code> is the hostname of the
machine that hosts the adaptor. By default the adaptor runs on port 5678.
<h4>Configure Adaptor</h4>
<li>Create a file named <code></code> in the
directory that contains the adaptor binary.
Here is an example configuration (bold items are example values to be
<p> Note: Backslashes are entered as double backslashes. In order
to represent a single '\' you need to enter '\\'.
<p> Note: DFS links can be given as
filesystemadaptor.src: <b>\\\\host\\dfsnamespace\\link</b>
<li> Create file named <code></code> in the same directory
that contains adaptor binary:
<li><p>Create a directory named logs in the same directory that contains
<li><p>Run the adaptor using:
<pre>java -jar adaptor-fs-YYYYMMDD-withlib.jar</pre>
<h4>Running as service on Windows</h4>
<p>Example execution with jsvc:
<pre>jsvc -pidfile -cp adaptor-fs-YYYYMMDD-withlib.jar</pre>
<h4>Optional <code></code> fields</h4>
Port on which to view web page showing information
and diagnostics. Defaults to "5679".
Accounts that are in the supportedAccounts will be
included in Acls regardless if they are builtin or
By default the value is:
NT AUTHORITY\\Authenticated Users
Builtin accounts are excluded from the Acls
that are pushed to the GSA. An account that starts with
this prefix is considered a builtin account and will be
excluded from the Acls.
By default the value is:
Time between incremental crawls. Default value is 300 seconds.
Namespace used for ACLs sent to GSA. Defaults to "Default".
<h4>Visit further
<a href="">
configuration documentation page
</a> to view supported set of optional parameters.
<h3> Advanced Topics </h3>
<h4>Document Last Access Dates</h4>
<p>The adaptor attempts to restore the last access date for documents after
it reads the document content during a crawl. In order for the last access
date to be restored back to the original value before the content was read,
the user account that the adaptor is running under needs to have write permission.
If the account has read-only permission and not write permission for documents,
then the last access date for documents will change as the adaptor reads
document content during a crawl.
<h3> Developer Topics </h3>
<h4>File System Adaptor Acl Overview</h4>
<p>ACLs for documents and folders are read, preserved and pushed to the Google
Search Appliance by the File System Adaptor for UNC and DFS UNC paths.
<p>The following images show the ACL inheritance used by the File System Adaptor.
The green and pink arrows signify inheritance. While the dotted arrows show an
optional inheritance depending on whether the item inherits permission from
its parent or if it breaks inheritance and defines its own set of permissions.
<h4>non-DFS ACL inheritance</h4>
<img src="non_dfs_acls.jpg" />
<h4>DFS ACL inheritance</h4>
<img src="dfs_acls.jpg" />