Start Here¶

Why should I use this build script?¶

This build script will make developing and deploying Splunk apps easier by:

• Creating installable Splunk packages (from a directory with the source code)
• Providing a simple method to deploy the changes to an app to a Splunk instance in seconds; this is useful during development since it will tell the Splunk instance to refresh so that your new content can be tested in real-time
• Providing mechanisms for deploying Splunk apps to a production box. This allows you to install the app remotely and restart the Splunk install accordingly using a Continuous Deployment system.
• Improving the performance of apps with Javascript views by minifying the CSS and JS files

Requirements¶

This build script is based around git (e.g. Github, Gitlab, Atlassian Bitbucket). Thus, you will need to customize it if you want to use another type of source code repository.

How do I use it?¶

Install Java and Ant¶

Install Java if you don't have it installed. There is a good chance you already have it so you may want to check.

Next, install Ant

Download the build script¶

Create a project¶

Put in your source code, build your app¶

Configure the¶

Contents¶