The Splunk Web Framework Toolkit is deprecated.
What deprecation means:
- The resources relating to the Splunk Web Framework Toolkit have been removed from dev.splunk.com. Documentation for the Splunk Web Framework is still available. Only the Splunk Web Framework Toolkit app is deprecated at this time, and the Splunk Web Framework app is archived on Splunkbase.
- Splunk will no longer provide feature enhancements, engineering support, or customer support for the Splunk Web Framework Toolkit.
Recommendation on new app development and app migration:
- Because Splunk is no longer investing in the Splunk Web Framework Toolkit, any new app development should be done using other approaches:
- Use the SplunkUI Toolkit (splunkui.splunk.com).
- SplunkUI examples gallery with GitHub links.
- For existing apps that use the Splunk Web Framework Toolkit, we request that developers migrate away from the Splunk Web Framework Toolkit. We encourage developers to provide feedback to Splunk at devinfo@splunk.com if there are any issues with migration.
Notice of removal:
- The Splunk Web Framework Toolkit will continue to be available as a public archive on GitHub, should other developers want to clone or fork the project.
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.
This section provides information about installing and using the Web Framework Toolkit.
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 Enterprise 6 and is available for Splunk Enterprise 5 from the Splunk Developer Portal.
The Web Framework Toolkit is built as a Splunk App, enabling interactive examples running within an instance of Splunk Enterprise 5 or 6.
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.
- Download and unzip the Web Framework Toolkit or clone the repository from GitHub.
- Copy the
/splunk_wftoolkitsubdirectory into$SPLUNK_HOME/etc/apps/. - Restart Splunk.
- In Splunk Web, navigate to the Web Framework Toolkit (http://localhost:8000/dj/splunk_wftoolkit).
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.
Stay connected with other developers building on Splunk.
| 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/ |
| @splunkdev |
If you would like to contribute to the framework, go here for more information:
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.
You can reach the Developer Platform team at devinfo@splunk.com.
The Splunk Web Framework is licensed under the Apache License 2.0. Details can be found in the LICENSE file.