Project

General

Profile

Start Here » History » Version 2

Luke Murphey, 03/05/2017 05:59 AM

1 1 Luke Murphey
h1. Start Here
2 2 Luke Murphey
3 2 Luke Murphey
h2. Why should I use this build script?
4 2 Luke Murphey
5 2 Luke Murphey
This build script will make developing and deploying Splunk apps easier by:
6 2 Luke Murphey
7 2 Luke Murphey
* *Creating installable Splunk packages* (from a directory with the source code)
8 2 Luke Murphey
* *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
9 2 Luke Murphey
* *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.
10 2 Luke Murphey
* *Improving the performance of apps* with Javascript views by minifying the CSS and JS files
11 2 Luke Murphey
12 2 Luke Murphey
h2. Requirements
13 2 Luke Murphey
14 2 Luke Murphey
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.
15 2 Luke Murphey
16 2 Luke Murphey
h2. How do I use it?
17 2 Luke Murphey
18 2 Luke Murphey
h3. Install Java and Ant
19 2 Luke Murphey
20 2 Luke Murphey
Install Java if you don't have it installed. There is a good chance you already have it so you may want to check.
21 2 Luke Murphey
22 2 Luke Murphey
Next, install Ant
23 2 Luke Murphey
24 2 Luke Murphey
h3. Download the build script
25 2 Luke Murphey
26 2 Luke Murphey
h3. Create a project
27 2 Luke Murphey
28 2 Luke Murphey
h3. Put in your source code, build your app
29 2 Luke Murphey
30 2 Luke Murphey
h3. Configure the 
31 2 Luke Murphey
32 2 Luke Murphey
h2. Contents
33 2 Luke Murphey
34 2 Luke Murphey
{{child_pages}}