Archive

Isolated Network Access Help

Explorer

Our team has a knowledge deficit in the .js area.

The Splunk instance is running on an isolated network.

When one selects Documentation under help, a timeout occurs with the response, "Unable to access online documentation."

We believe this response is coded in $SPLUNK_HOME\share\splunk\search_mrsparkel\templates\top\help.html:149

We have attempted to modify this help.html file with references to local index files, f.e.:

window.location='file:///C:/Program Files/Splunk ... >> on out to the help.index of interest

Other than modifying the MAX CONNECTION TIMEOUT to a lower number and changing the output string at :149 we've been unable to obtain a successful display of the documentation shipped with the installed instance.

Tags (2)
1 Solution

Legend

The documentation is not shipped with Splunk. The documentation is available online at http://docs.splunk.com/Documentation If your Splunk is located on an isolated network, all the in-product links to splunk.com will not work, no matter how long you set the timeout.

However, documentation for the configuration files can be found locally at $SPLUNK_HOME\etc\system\README. This documentation is in plain text.

Many companies have their Splunk installations on an isolated network. You just have to go to a different machine - one with Internet access - to read the documentation.

View solution in original post

Legend

The documentation is not shipped with Splunk. The documentation is available online at http://docs.splunk.com/Documentation If your Splunk is located on an isolated network, all the in-product links to splunk.com will not work, no matter how long you set the timeout.

However, documentation for the configuration files can be found locally at $SPLUNK_HOME\etc\system\README. This documentation is in plain text.

Many companies have their Splunk installations on an isolated network. You just have to go to a different machine - one with Internet access - to read the documentation.

View solution in original post

Explorer

As lguinn pointed out, there is no mirror of product documentation installed with the product.

There is the Getting Started app ... enabling this app provides some good intro info.

Two interesting references for developers:

splunk:8000/info >> Development Services - info about individual system modules

splunk:8000/static/docs/bubbles/index.html >> Style Guide - example of the various object display methods

For our network, we'll likely redirect the Documentation link to a local wiki on which select copies of product documentation are available.