Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
GitHub App
Python Shell
tag: v1.0.2

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
appserver/static
bin
default
lib/joblib
metadata
.gitignore
How to test scripts.txt
LICENSE.txt
README.md

README.md

This application needs an awesome software called Splunk.

Currently the application is tested and the documentation written for Mac OS X 10.7

Getting started

Installing splunk

Generic instructions

  • Download Splunk for your platform.
  • Unpack/Install Splunk by running the downloaded files.
  • Follow the instructions on screen
  • When done continue to Installing Splunkgit App section

Mac OS X 10.7 instructions

  • Use this direct link to download a gzipped tar ball of Splunk.
  • Open a Terminal
  • Untar/unzip the downloaded file: tar -xvf <FILE_NAME>
  • When done continue to Installing Splunkgit App section

<SPLUNK_ROOT> is the direcotry where you extracted splunk:

Installing splunkgit

  • Make sure splunk is not running
  • Open Terminal app
  • Goto <SPLUNK_ROOT>: cd <SPLUNK_ROOT>
  • Goto app directory: cd etc/apps
  • Download the app: git clone git://github.com/splunk/splunk-app-splunkgit.git
    You can also download a released version from the tags page.
  • Goto Splunkgit directory: cd splunk-app-splunkgit
  • Create a directory called local: mkdir local
  • Copy splunkgit.conf from default to local: cp default/splunkgit.conf local

Configuration

  • Make sure splunk is not running
  • Open Terminal app
  • Goto <SPLUNK_ROOT>/etc/apps/splunk-app-aplunkgit
  • Edit local/splunkgit.conf with a text editor (open -e local/splunkgit.conf) and assign the following values:
    • repo_address= The address to the repo, use the read-only address. Ex: git://github.com/splunk/splunk-app-splunkgit.git
    • user_login_name= The login name of the repo owner in github. Ex: splunk
    • repo_name= The name of the github repo. Ex: splunk-app-splunkgit
    • user= Splunk user login so our scripts can search in Splunk
    • password= Splunk password for the user

Changing repository

  • Make sure splunk is not running
  • Run the following command to wipe all app data from splunk:

    splunk clean eventdata -f -index splunkgit
    
  • Change the splunkgit.conf file, as described in Configuration section, to point to the new repo.

Starting and stopping Splunk

  • Open Terminal
  • Goto <SPLUNK_ROOT>: cd <SPLUNK_ROOT>
  • Start splunk bin/splunk start
    • On you web browser goto http://localhost:8000
    • If asked enter your name and user name (default value is admin:password)
    • If you change the password, you also need the change the configuration file to match this.
  • Stop splunk: bin/splunk stop

Third party libraries

Known issues

  • If you clone this repository, install the app and start up Splunk without configurating your own splunkgit.conf (as explained in Changing repository) splunk will get git repository data from this repositories .git directory.
  • Currently only read-only addresses work. Don't use https or git@github addresses.

License

Copyright 2011 Splunk, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Something went wrong with that request. Please try again.