https://github.com/kwent/pgbouncerhero

A dashboard for your PgBouncers.
https://github.com/kwent/pgbouncerhero

dashboard engine gui pgbouncer postgresql

Last synced: about 1 month ago
JSON representation

A dashboard for your PgBouncers.

• Host: GitHub
• URL: https://github.com/kwent/pgbouncerhero
• Owner: kwent
• License: mit
• Created: 2017-01-28T04:32:27.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-08T15:29:54.000Z (almost 2 years ago)
• Last Synced: 2024-10-01T18:06:58.569Z (2 months ago)
• Topics: dashboard, engine, gui, pgbouncer, postgresql
• Language: HTML
• Homepage: https://pgbouncerhero-demo.herokuapp.com/
• Size: 367 KB
• Stars: 244
• Watchers: 8
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# PgBouncerHero

A graphical user interface for your PGBouncers.

[See it in action](https://pgbouncerhero-demo.herokuapp.com/). [Source Code](https://github.com/kwent/pgbouncerhero-demo).

[![Screenshot1](https://github.com/kwent/pgbouncerhero/blob/master/doc/screenshot-1.png?raw=true)](https://pgbouncerhero-demo.herokuapp.com/)

[![Screenshot2](https://github.com/kwent/pgbouncerhero/blob/master/doc/screenshot-2.png?raw=true)](https://pgbouncerhero-demo.herokuapp.com/)

[![Screenshot2](https://github.com/kwent/pgbouncerhero/blob/master/doc/screenshot-3.png?raw=true)](https://pgbouncerhero-demo.herokuapp.com/)

## Installation

PgBouncerHero is available as a Rails engine.

Add those dependencies to your application’s Gemfile:

```ruby

gem 'pgbouncerhero'

```

And mount the engine in your `config/routes.rb`:

```ruby

mount PgBouncerHero::Engine, at: "pgbouncerhero"

```

### Basic Authentication

Set the following variables in your environment or an initializer.

```ruby

ENV["PGBOUNCERHERO_USERNAME"] = "zelda"

ENV["PGBOUNCERHERO_PASSWORD"] = "triforce"

```

### Devise

```ruby

authenticate :user, -> (user) { user.admin? } do

  mount PgBouncerHero::Engine, at: "pgbouncerhero"

end

```

## One PgBouncer

```bash

export PGBOUNCERHERO_DATABASE_URL=postgres://user:password@host:port/pgbouncer

```

## Multiple PgBouncers

Create `config/pgbouncerhero.yml` with:

```yml

default: &default

  pgbouncers:

    production:

      master:

        url: <%= ENV["PGBOUNCER_PRODUCTION_MASTER_DATABASE_URL"] %>

      slave:

        url: <%= ENV["PGBOUNCER_PRODUCTION_SLAVE_DATABASE_URL"] %>

    staging:

      master:

        url: <%= ENV["PGBOUNCER_STAGING_MASTER_DATABASE_URL"] %>

      slave:

        url: <%= ENV["PGBOUNCER_STAGING_SLAVE_DATABASE_URL"] %>

development:

  <<: *default

production:

  <<: *default

```

# Authors

- [Quentin Rousseau](https://github.com/kwent)

# License

```plain

Copyright (c) 2022 Quentin Rousseau 

MIT License

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

```