Git Product home page Git Product logo

foreman_custom_banner's Introduction

foreman_custom_banner

A Foreman plugin which provides a configurable, custom banner for the Foreman UI.

The purpose of this plugin is to provide a simple way to distinguish multiple installations of Foreman, e.g. a production vs. a development installation. As well as the possibility of a link to a "help" or "quick start" page.

Installation

  • Build and install the rubygem
  • Add install/foreman_custom_banner.rb into Foreman's bundler.d directory. E.g. in the packaged Foreman installation, /usr/share/foreman/bundler.d
  • Restart the webserver hosting the Foreman application

Configuration

You configure the custom banner from the Settings page on the Custom Banner tab:

custom_banner_settings_preview

With a default installation the custom banner would look like this:

default_custom_banner_preview

If you only wanted to have a banner text simply remove the custom_banner_url and custom_banner_url_text values:

text_custom\banner_preview

If you only wanted to have a banner url simply remove the custom_banner_text value:

url_custom_banner_preview

You can alter the style of the custom banner by changing the values for the custom_banner_style field. This field will accept any CSS style configuration

Building the Package

YMMV, but this should work okay if you have the right build dependencies installed:

$ gem build foreman_custom_banner.gemspec
$ mv *.gem $(rpm --eval '%{_sourcedir}')
$ rpmbuild -ba foreman_custom_banner.spec --define 'scl tfm'

foreman_custom_banner's People

Contributors

jcmcken avatar stbenjam avatar

Stargazers

avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar

Forkers

stbenjam discreet litvin

foreman_custom_banner's Issues

Hyperlink in Custom Banner

It would be cool if one had the ability to have a hyperlink in the Custom Banner which can link to a "help" page or "quick start guide" for the specific foreman instance.

Release under GPL

Every now and then people are looking for this feature in Foreman. It's a great plugin, I'd like to package it up (addresses #2), but the license for this repo would need to be GPL because of how Foreman plugins work, see http://www.gnu.org/licenses/gpl-faq.en.html#GPLAndPlugins.

It's a small nitpick, but to get the package into the repos the licensing would need to be correct.

build el7 rpm for foreman_custom_banner

For the non-ruby user like myself, could you please build an el7 rpm that can be installed with a simple 'yum install ruby193-rubygem-foreman_custom_banner' from the foreman repo?

I have spend the last 2 hours trying to get this installed using various tutorials around the web and am unable to find a clear and concise way to get this plugin installed, and I am way out of depth trying to diagnose ruby related issues. Thanks.

Incompatible with newer Forman Versions

As far as I was able to test, the banner is only visible on the Foreman Login Page with Foreman v1.17+. No Banner on other Foreman-Sites.

The reason for this seems to be the new Interface with the vertical sidebar,...

If this is unmaintained, I will probably look into it but not in the next few weeks.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.