Steps to integrate pgHero with Rails

integrate_pg_hero.rb

## Gemfile

gem 'pghero'
# pg_query is used by pghero to provide suggestions to add indexes
gem 'pg_query', '>= 0.9.0'

# bundle install

## Add a route to access the pgHero Dashboard 
# You can secure its access with Devise user authentication
# Here we're giving access to only the users with super_admin role

## config/routes/rb
authenticate :user, -> (user) { user.has_role?(:super_admin) } do
  mount PgHero::Engine, at: "pgdashboard"
end
  
## Alternatively, 
# you can also secure the Dashboard with basic HTTP authentication

## config/routes/rb
mount PgHero::Engine, at: "pgdashboard"

# Add  environment variables mentioned as per below 
ENV["PGHERO_USERNAME"] = "<username>"
ENV["PGHERO_PASSWORD"] = "<password>"

## You may link to link it with you admin portal

# some-menu.html.erb
<%= link_to "Database Analyzer", pg_hero_path, target: :blank %>

## Restart your rails application and try to access "/pgdashboard" path