Splunk Search

Change/disable 4.2 Help link

kevintelford
Path Finder

We're using Splunk on a network that is cordoned off from the interwebs. Is there a way that we could either disable or change the url that the ?Help link points to for all apps?

Thanks, Kevin

1 Solution

netwrkr
Communicator

Yes. You would need to modify the AppBar module by hand though.

Specifically, I believe this section

<div class="auxLinks">
    <a class="help" href="${generateSelfHelpLink()}" target="_blank" title="${_('Splunk help')}">${_("Help")}</a>
    <span>|</span>
    <a class="aboutLink" href="#about" title="${_('About Splunk')}">${_("About")}</a>
    <!-- moved Print link into the Actions menu
    <span>|</span>
    <a class="printLink" href="#print" class="last">${_("Print")}</a>
    -->

in

$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/nav/AppBar.html

View solution in original post

yoho
Contributor

You can redirect to your own webserver by changing the following parameter in web.conf (as usual can be done at the user, app or system level) :

[settings]
docsCheckerBaseURL = http://quickdraw.splunk.com/help

The webserver will be queried this way :

$docsCheckerBaseURL/$license/$versionNumber/$location/$installType/$skin?locale=$locale

with the following parameters :


$license: {free | pro} the product license level
$versionNumber: the textual product version label, i.e. 3.4.6
$location: the keyword identifier for the requesting asset, i.e. 'documentation'
$installType: {trial | prod} the license type, i.e. unpaid trial or fully licensed
$skin: the current skin theme
$locale: the user's locale, i.e., en-US

$location is itself built like this (when help button is pressed from an app view) :

[$app_name:$app_version]app.$app_name.$app_view

0 Karma

yoho
Contributor

By going further, I've found that the webserver shouldn't directly answer to splunk with the "Help" HTML page. It should reply with a sort of text file (javascript?) containing these lines:


var helpParams = {url:'http://webserver/myhelppage.html'}; showHelp(helpParams);

It makes the process a bit more complicated but allows your webserver to redirect to different URLs based on the different parameters provided in the initial URL (thus, providing contextual help).

0 Karma

netwrkr
Communicator

Yes. You would need to modify the AppBar module by hand though.

Specifically, I believe this section

<div class="auxLinks">
    <a class="help" href="${generateSelfHelpLink()}" target="_blank" title="${_('Splunk help')}">${_("Help")}</a>
    <span>|</span>
    <a class="aboutLink" href="#about" title="${_('About Splunk')}">${_("About")}</a>
    <!-- moved Print link into the Actions menu
    <span>|</span>
    <a class="printLink" href="#print" class="last">${_("Print")}</a>
    -->

in

$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/nav/AppBar.html

yoho
Contributor

If you over your mouse over the Help Button, you should see the URL contains the app name you're using as well as the view name but this URL by default, redirects to Splunk documentation. Thus, I believe there is a "softer" way to redirect to your own page. I have not found it out yet, though...

0 Karma

kevintelford
Path Finder

Thank you much.

0 Karma
Get Updates on the Splunk Community!

Splunk Observability Cloud | Unified Identity - Now Available for Existing Splunk ...

Raise your hand if you’ve already forgotten your username or password when logging into an account. (We can’t ...

Index This | How many sides does a circle have?

February 2024 Edition Hayyy Splunk Education Enthusiasts and the Eternally Curious!  We’re back with another ...

Registration for Splunk University is Now Open!

Are you ready for an adventure in learning?   Brace yourselves because Splunk University is back, and it's ...