https://github.com/splunk/dashboard-conf19-examples
Splunk new dashboard framework examples .conf 2019
https://github.com/splunk/dashboard-conf19-examples
Last synced: 7 months ago
JSON representation
Splunk new dashboard framework examples .conf 2019
- Host: GitHub
- URL: https://github.com/splunk/dashboard-conf19-examples
- Owner: splunk
- Created: 2019-09-08T04:36:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-28T04:18:11.000Z (over 2 years ago)
- Last Synced: 2024-04-15T02:58:39.311Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 4.04 MB
- Stars: 32
- Watchers: 28
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Splunk Dashboard Framework Examples
## Prerequisite
* Install [nodejs](https://nodejs.org/en/) 16.x.
* Install Splunk Enterprise locally and have $SPLUNK_HOME env variable setup.
* In Windows environment, to avoid any file permission issues start the command prompt with "Run as Administrator" to run the commands mentioned in the [Development](#development) section.
## Development
* `npm install` - install dependencies.
* `npm run dev` - start the project in dev mode. This command will symlink the project into your Splunk instance.
* Restart your Splunk instance if it's the first time you setup this project. `Dashboard Framework Examples` application should shows up in app bar.
## How to create a new page
* Add an xml file in `resources/default/data/ui/views`.
* Modify `resources/default/data/ui/nav/default.xml` to include your new page.
* Create a new folder under `src/pages/` with the same name of the new xml file.
* Create `index.jsx` and bootstrap the page using `@splunk/react-page`.
* Restart Splunk, your new page should shows up.
# Package the app
Use the following steps to package the Dashboard app.
Requirements:
* Make
* [Docker](https://docs.docker.com/install/)
* NOTE: May not run on Apple Silicon Macs. YMMV.
Steps:
* Run `make build-image` to build the image to package the app.
* Run `make run` to package the app with NodeJS.
* The app (`tgz`) will be created in the `splunkapps` folder.
* To start Splunk (`9.x`) with the dashboard app run `make start` (username: `admin` password: `changemeplease1`).
* Remove all containers run `make down`