Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Latest commit

 

History

History
83 lines (56 loc) · 2.72 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.72 KB
Raw

Note

This plugin no longer works in recent Graylog versions and is archived. It is provided only for historical purposes in case someone needs access to the source code.

SSO Authentication Plugin for Graylog

Build Status

This plugins adds SSO (Single Sign-On) capabilities to Graylog. It supports automatic login and user account creation based on trusted HTTP headers set by an authentication proxy.

Required Graylog version: 3.3.x.

This plugin will not be compatible with Graylog 4.0 and later!

Version Compatibility

Plugin Version Graylog Version
3.3.x 3.3.x
3.2.x 3.2.x
3.1.x 3.1.x
3.0.x 3.0.x
2.5.x 2.5.x
2.4.x 2.4.x
2.3.x 2.3.x
1.0.x >=2.1.x, <2.3.x

Installation

Download the plugin and place the .jar file in your Graylog plugin directory. The plugin directory is the plugins/ folder relative from your graylog-server directory by default and can be configured in your graylog.conf file.

Restart graylog-server and you are done.

Development

You can improve your development experience for the web interface part of your plugin dramatically by making use of hot reloading. To do this, do the following:

  • git clone https://github.com/Graylog2/graylog2-server.git
  • cd graylog2-server/graylog2-web-interface
  • ln -s $YOURPLUGIN plugin/
  • npm install && npm start

Usage

How this Plugin can be used is described in the Graylog Documentation

Getting started

This project is using Maven 3 and requires Java 8 or higher.

  • Clone this repository.
  • Run mvn package to build a JAR file.
  • Optional: Run mvn jdeb:jdeb and mvn rpm:rpm to create a DEB and RPM package respectively.
  • Copy generated JAR file in target directory to your Graylog plugin directory.
  • Restart the Graylog.

Plugin Release

  • Bump version in package.json
  • Bump parent version and graylog.version in pom.xml
  • Change branch name for the graylog2-server checkout in .travis.yml

For the rest we are using the maven release plugin:

$ mvn release:prepare

(no need for mvn release:perform)

This sets the version numbers, creates a tag and pushes to GitHub. Travis CI will build the release artifacts and upload to GitHub automatically.