Skip to content

Commit

Permalink
[#25171] Splunk README > Split out admin content to child pages (#120)
Browse files Browse the repository at this point in the history
* Updated Readme and added Admin Guide

* Resolved Typos

* Removed Marketplace and minor changes

* Updated Installation Info

Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com>

* Removed the admin section

---------

Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com>
  • Loading branch information
Reene-Simon and mickmister authored Nov 9, 2023
1 parent 9ccd4b3 commit 2b51166
Showing 1 changed file with 29 additions and 19 deletions.
48 changes: 29 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,32 @@
# Splunk Plugin
# Mattermost Splunk Plugin
![CircleCI branch](https://img.shields.io/circleci/project/github/mattermost/mattermost-plugin-splunk/master.svg)
[![Code Coverage](https://img.shields.io/codecov/c/github/mattermost/mattermost-plugin-splunk/master.svg)](https://codecov.io/gh/mattermost/mattermost-plugin-splunk/branch/master)
[![Go Report Card](https://goreportcard.com/badge/github.com/mattermost/mattermost-plugin-splunk)](https://goreportcard.com/report/github.com/mattermost/mattermost-plugin-splunk)
[![HW](https://img.shields.io/github/issues/mattermost/mattermost-plugin-splunk/Up%20For%20Grabs?color=dark%20green&label=Help%20Wanted)](https://github.com/mattermost/mattermost-plugin-splunk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Up+For+Grabs%22+label%3A%22Help+Wanted%22)

**Maintainer:** [@dbejanishvili](https://github.com/dbejanishvili)
**Co-Maintainers:** [@bakurits](https://github.com/bakurits) [@Gvantsats](https://github.com/Gvantsats)

A Splunk integration for Mattermost which enables users to get logs and alerts from Splunk server.

## Admin guide
## Contents
- [Overview](#overview)
- [Installation](#installation)
- [End User Guide](#end-user-guide)
- [Contribute](#contribute)
- [Development](#development)
- [License](#license)
- [Get Help](#get-help)
- [Help Wanted](#help-wanted)

### Installation
## Overview

A Splunk integration for Mattermost which enables users to get logs and alerts from Splunk server.

#### Marketplace installation
1. In Mattermost, go to **Main Menu > Plugin Marketplace**.
2. Search for "Splunk" or find the plugin from the list.
3. Select **Install**.
4. When the plugin has downloaded and been installed, select **Configure**.
## Installation

#### Manual installation
If your server doesn't have access to the internet, you can download the [latest plugin binary release](https://github.com/mattermost/mattermost-plugin-splunk/releases) and upload it to your server via **System Console > Plugin Management**. The releases on this page are the same used by the Marketplace. To learn more about how to upload a plugin, see the [Mattermost Developer documentation](https://developers.mattermost.com/integrate/plugins/using-and-managing-plugins/).
You can download the [latest plugin binary release](https://github.com/mattermost/mattermost-plugin-splunk/releases) and upload it to your server via **System Console > Plugin Management**.

## User guide
## End User Guide

- **Authenticate user**: Use ``/splunk auth login [server base url] [splunk username]/[token]``.
- You must be logged into the system before you can use any slash commands regarding logging. To authenticate the user, you can use this slash command with two required parameters: Splunk server base URL, Splunk username, or token.
Expand All @@ -40,6 +49,10 @@ If your server doesn't have access to the internet, you can download the [latest

![image](https://github.com/mattermost/mattermost-plugin-splunk/assets/74422101/f689b63e-9090-4ab5-8dc2-af1152440c02)

## Contribute

This plugin contains both a server and web app portion. Read our documentation about the [Developer Workflow](https://developers.mattermost.com/extend/plugins/developer-workflow/) and [Developer Setup](https://developers.mattermost.com/extend/plugins/developer-setup/) for more information about developing and extending plugins.

## Development

### Set up environment
Expand Down Expand Up @@ -89,18 +102,15 @@ make deploy

In production, deploy and upload your plugin via the Mattermost System Console. See the [Mattermost Developer documentation](https://developers.mattermost.com/integrate/plugins/using-and-managing-plugins/) for details.

## Help and support

For questions, suggestions, and help, visit the [Splunk Plugin channel](https://community.mattermost.com/core/channels/plugin-splunk) on our Community server. To report a bug, please open a GitHub issue.

## License

This repository is licensed under the [Apache 2.0 License](https://github.com/mattermost/mattermost-plugin-splunk/blob/master/LICENSE).

## Contributing
## Get Help

For questions, suggestions, and help, visit the [Splunk Plugin channel](https://community.mattermost.com/core/channels/plugin-splunk) on our Community server. To report a bug, please open a GitHub issue.

This plugin contains both a server and web app portion. Read our documentation about the [Developer Workflow](https://developers.mattermost.com/extend/plugins/developer-workflow/) and [Developer Setup](https://developers.mattermost.com/extend/plugins/developer-setup/) for more information about developing and extending plugins.

## Help wanted
## Help Wanted

If you're interested in joining our community of developers who contribute to Mattermost, check out the current set of issues that are being requested. You can also find issues labeled "Help Wanted" in the Jira repository that we have laid out the primary requirements for and could use some coding help from the community.

0 comments on commit 2b51166

Please sign in to comment.