Install the Splunk Add-on for GitHub
- Get the Splunk Add-on for GitHub by downloading it from Splunkbase or browsing to it using the app browser within Splunk Web.
- Determine where and how to install this add-on in your deployment using the tables on this page.
- Perform any prerequisite steps before installing as required and specified in the following tables.
- Complete your installation.
For step-by-step instructions on how to install an add-on in your specific deployment environment, see the installation walkthroughs section for links to installation instructions specific to a single-instance deployment, distributed deployment, or Splunk Cloud.
Use the tables below to determine where and how to install this add-on in a distributed deployment of Splunk Enterprise.
Where to install this add-on
This table provides a quick reference for installing this add-on to a distributed deployment of Splunk Enterprise.
|Splunk instance type||Supported||Required||Comments|
|Search Heads||Yes||Yes||Install this add-on to all search heads that require GitHub knowledge management.|
|Indexers||Yes||No||Not required, because the parsing operations occur on the heavy forwarders.|
|Heavy Forwarders||Yes||Yes||Install this add-on on heavy forwarders to perform data collection via modular inputs.|
|Universal Forwarders||No||No||Install this add-on on a heavy forwarder for data collection|
Distributed deployment feature compatibility
This table provides a quick reference for the compatibility of this add-on with Splunk distributed deployment features.
|Distributed deployment feature||Supported||Comments|
|Search Head Clusters||Yes||You can install this add-on on a search head cluster for all search-time functionality.|
|Indexer Clusters||Yes||Supported for deploying the Add-on.|
|Deployment Server||Yes||Supported for deploying the Add-on.|
The Splunk Add-Ons manual includes an Installing add-ons guide that helps you successfully install any Splunk-supported add-on to your Splunk platform.
For a walkthrough of the installation procedure, follow the link that matches your deployment scenario:
Installation overview for the Splunk Add-on for GitHub
Configure your GitHub Enterprise server to send data to the Splunk Add-on for GitHub
This documentation applies to the following versions of Splunk® Supported Add-ons: released