The Splunk Web Framework Toolkit

Version 1.0

The Splunk Web Framework Toolkit is a resource to help developers learn how to
build rich applications using the Splunk Web Framework.
This app contains a collection of examples that show you how to use the components of the
Web Framework. You will find documentation and reference information, along with
code templates and additional components that you can use within your own Splunk
Apps.

Getting Started

This section provides information about installing and using the Web Framework Toolkit.

Requirements

Here are the Web Framework Toolkit requirements for this release:

Operating System: Windows, Linux, or Mac OS X.
Web browsers: Latest versions of Chrome, Safari, or Firefox, Internet Explorer 9 or later.
The Splunk Web Framework: The Web Framework is included in Splunk 6 and is available for Splunk 5 from the
Splunk Developer Portal.

Installing the Web Framework Toolkit

The Web Framework Toolkit is built as a Splunk App, enabling interactive examples running within a Splunk 5 or 6
instance.

Installing from Splunk Web

If you downloaded the Web Framework Toolkit from Splunk Apps, you can install the toolkit
within Splunk Web.

For more, see Where to get more apps and add-ons.

Installing from a ZIP Source File

Download and unzip the Web Framework Toolkit
or clone the repository from GitHub.
Copy the /splunk_wftoolkit subdirectory into $SPLUNK_HOME/etc/apps/.
Restart Splunk.
In Splunk Web, navigate to the Web Framework Toolkit (*http://localhost:8000/dj/splunk_wftoolkit*).

Documentation and resources

When you need to know more:

For all things developer with Splunk, your main resource is the Splunk Developer Portal.
For conceptual and how-to documentation, see the Overview of the Splunk Web Framework.
For component reference documentation, see the Splunk Web Framework Reference.
For more about Splunk in general, see Splunk>Docs.

Community

Stay connected with other developers building on Splunk.

Email devinfo@splunk.com
Issues https://github.com/splunk/splunk-webframework-toolkit/issues/
Answers http://splunk-base.splunk.com/tags/appfx/
Blog http://blogs.splunk.com/dev/
Twitter @splunkdev

How to contribute

If you would like to contribute to the framework, go here for more information:

Support

This version of the Splunk Web Framework Toolkit is officially supported by the Splunk Support Team.

Please feel free to open issues and provide feedback either through GitHub Issues or by contacting the team directly.

Contact Us

You can reach the Developer Platform team at devinfo@splunk.com.

License

The Splunk Web Framework is licensed under the Apache License 2.0. Details can be found in the LICENSE file.