Click here to show your appreciation or please just leave a rating by clicking above!
Source code | Feature requests and bugs | My other apps
This app allows changing of files just like you are on the filesystem; it should be used very carefully in any environment that you care about.
default/ folders. You should follow normal Splunk /local/*.conf files or files in default/ if you are the developer of that appThere are examples of how to create common custom actions for the home tab (reload deploy-server, bundle push etc). Look at the file ./etc/apps/config_explorer/default/config_explorer.conf.example
Is your server a deployment-server or search head cluster deployer, and you would like to use btool on the apps that are pushed? If so, read etc/apps/config_explorer/default/config_explorer.conf.example.
There is some basic audit logging here:
index=_internal source="*config_explorer.log"
Copyright (C) 2019 Chris Younger
I am a Splunk Professional Services consultant working for JDS Australia (https://www.jds.net.au), in Brisbane Australia.
Before enabling the git auto-complete feature you must first create a git repository somewhere. For example:
$ cd /opt/splunk/etc
$ git init
You will probably also need to set a username and email address for config_explorer to use for commits:
git config user.name config_explorer
git config user.email config_explorer@example.com
If you wish to use a non-standard git repository location, you can set these environment variables:
export GIT_DIR=/opt/splunk/.git/
export GIT_WORK_TREE=/opt/splunk/
You will need to consider your .gitignore file. If your directory already has .gitignore files in it, you
may instead need to make a .gitignore file that ignores deeper nested .gitignore files.
Finally, if you want to push changes to an external repo, I would recommend you create a script input
to do so, or alternatively, see my custom git app here: https://splunkbase.splunk.com/app/4182/
In order to prevent file editing semi-permanantly, set write_access = false and hide_settings = true.
This will prevent being able to change settings until someone changes files directly on the filesystem.
The following third-party libraries are used by this app. Thank you!
v 1.7.15 - 2022-10-03 * You can now right click on text that looks like file paths and select "Attempt to open" to open a file or navigate to a folder * There is some new default hooks in default/config_explorer.conf * Post-save options are now shown in a slide-up panel * Add special support for manager-apps folder * New preferences option to show full paths in tab bar
v 1.6.14 - 2022-05-15 * Fixed to no longer use HTML dashboards
v 1.5.13 - 2022-03-08 * Fix some btool errors
v 1.6.14 - 2022-05-15
* Fixed to no longer use HTML dashboards
v 1.5.13 - 2022-03-08
* Fix some btool errors
v 1.5.12 - 2022-03-01
Hover tooltips less hyperactive and a preference option to disable
Improved gutter hinting for configuration in master-apps (for cluster manager servers)
New option to right-click and provide direct link to a section of code
New ability to reload deploy-server (for deployment servers). Right click on files in the deployment-apps directory to use.
As Config Explorer uses a persistent rest process, it may need a Splunk restart for the reload deploy-server to work.
v 1.4.9 - 2020-06-09
* Python 3 fixes
v 1.5.13 - 2022-03-08
* Fix some btool errors
v 1.5.12 - 2022-03-01
Hover tooltips less hyperactive and a preference option to disable
Improved gutter hinting for configuration in master-apps (for cluster manager servers)
New option to right-click and provide direct link to a section of code
New ability to reload deploy-server (for deployment servers). Right click on files in the deployment-apps directory to use.
As Config Explorer uses a persistent rest process, it may need a Splunk restart for the reload deploy-server to work.
v 1.4.9 - 2020-06-09
* Python 3 fixes
v 1.4.7 - 2020-04-08
* Better error handling for folders that contain symlinks
v 1.4.6 - 2020-04-05
Will show a warning message if an open file has been changed.
Files are now saved with the correct line endings instead of defaulting to Windows line endings.
Added hotkeys to quickly navigate between tabs. ALT-SHIFT-[LEFT,RIGHT,UP]
The left pane now shows file size and last modified time for files (drag panel to make it wider)
v 1.5.12 - 2022-03-01
Hover tooltips less hyperactive and a preference option to disable
Improved gutter hinting for configuration in master-apps (for cluster manager servers)
New option to right-click and provide direct link to a section of code
New ability to reload deploy-server (for deployment servers). Right click on files in the deployment-apps directory to use.
As Config Explorer uses a persistent rest process, it may need a Splunk restart for the reload deploy-server to work.
v 1.4.9 - 2020-06-09
* Python 3 fixes
v 1.4.7 - 2020-04-08
* Better error handling for folders that contain symlinks
v 1.4.6 - 2020-04-05
Will show a warning message if an open file has been changed.
Files are now saved with the correct line endings instead of defaulting to Windows line endings.
Added hotkeys to quickly navigate between tabs. ALT-SHIFT-[LEFT,RIGHT,UP]
The left pane now shows file size and last modified time for files (drag panel to make it wider)
v 1.5.11 - 2022-02-28
Hover tooltips less hyperactive and a preference option to disable
Improved gutter hinting for configuration in master-apps (for cluster manager servers)
New option to right-click and provide direct link to a section of code
New ability to reload deploy-server (for deployment servers). Right click on files in the deployment-apps directory to use.
As Config Explorer uses a persistent rest process, it may need a Splunk restart for the reload deploy-server to work.
v 1.4.9 - 2020-06-09
* Python 3 fixes
v 1.4.7 - 2020-04-08
* Better error handling for folders that contain symlinks
v 1.4.6 - 2020-04-05
Will show a warning message if an open file has been changed.
Files are now saved with the correct line endings instead of defaulting to Windows line endings.
Added hotkeys to quickly navigate between tabs. ALT-SHIFT-[LEFT,RIGHT,UP]
The left pane now shows file size and last modified time for files (drag panel to make it wider)
v 1.4.9 - 2020-06-09
* Python 3 fixes
v 1.4.7 - 2020-04-08
* Better error handling for folders that contain symlinks
v 1.4.6 - 2020-04-05
Will show a warning message if an open file has been changed.
Files are now saved with the correct line endings instead of defaulting to Windows line endings.
Added hotkeys to quickly navigate between tabs. ALT-SHIFT-[LEFT,RIGHT,UP]
The left pane now shows file size and last modified time for files (drag panel to make it wider)
v 1.3.5 - 2020-02-09
Upgrade Monaco editor from 0.15 to 0.19.3
Fixes for python 3
* Removed restrictions around saving files/folders with extended characters in the name
v 1.2.5 - 2019-07-21
Fix bugs in "Download" functionality and Splunk 7.3 on Windows (Thanks Brett)
Enhancements for using btool on shcluster and deployment-apps folders (Thanks neusse)
* Enhancements for hiding only system/defaults in btool (Thanks Marco)
v 1.4.7 - 2020-04-08
* Better error handling for folders that contain symlinks
v 1.4.6 - 2020-04-05
Will show a warning message if an open file has been changed.
Files are now saved with the correct line endings instead of defaulting to Windows line endings.
Added hotkeys to quickly navigate between tabs. ALT-SHIFT-[LEFT,RIGHT,UP]
The left pane now shows file size and last modified time for files (drag panel to make it wider)
v 1.3.5 - 2020-02-09
Upgrade Monaco editor from 0.15 to 0.19.3
Fixes for python 3
* Removed restrictions around saving files/folders with extended characters in the name
v 1.2.5 - 2019-07-21
Fix bugs in "Download" functionality and Splunk 7.3 on Windows (Thanks Brett)
Enhancements for using btool on shcluster and deployment-apps folders (Thanks neusse)
* Enhancements for hiding only system/defaults in btool (Thanks Marco)
v 1.4.6 - 2020-04-05
Will show a warning message if an open file has been changed.
Files are now saved with the correct line endings instead of defaulting to Windows line endings.
Added hotkeys to quickly navigate between tabs. ALT-SHIFT-[LEFT,RIGHT,UP]
The left pane now shows file size and last modified time for files (drag panel to make it wider)
v 1.3.5 - 2020-02-09
Upgrade Monaco editor from 0.15 to 0.19.3
Fixes for python 3
* Removed restrictions around saving files/folders with extended characters in the name
v 1.2.5 - 2019-07-21
Fix bugs in "Download" functionality and Splunk 7.3 on Windows (Thanks Brett)
Enhancements for using btool on shcluster and deployment-apps folders (Thanks neusse)
* Enhancements for hiding only system/defaults in btool (Thanks Marco)
Version 1.2.5
Fix bugs in "Download" functionality and Splunk 7.3 on Windows (Thanks Brett)
Enhancements for using btool on shcluster and deployment-apps folders (Thanks neusse)
* Enhancements for hiding only system/defaults in btool (Thanks Marco)
Version 1.1.5
* New right-click option to download file
Version 1.1.4
The "post-save" can now reuse tabs and can run in the background so it doesn't interrupt development flow.
You can now add custom actions as buttons on the home tab. Including actions that require splunk authentication.
Added preferences screen for setting word-wrap, visible whitespace and any other monaco editor settings.
Added a "reload from disk" right-click option.
Full change log here: https://github.com/ChrisYounger/config_explorer/commits/master
Version 1.1.5
* New right-click option to download file
Version 1.1.4
The "post-save" can now reuse tabs and can run in the background so it doesn't interrupt development flow.
You can now add custom actions as buttons on the home tab. Including actions that require splunk authentication.
Added preferences screen for setting word-wrap, visible whitespace and any other monaco editor settings.
Added a "reload from disk" right-click option.
Full change log here: https://github.com/ChrisYounger/config_explorer/commits/master
Full change log here: https://github.com/ChrisYounger/config_explorer/commits/master
Full change log here: https://github.com/ChrisYounger/config_explorer/commits/master
As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.