Gem Version Current Build Status Inline docs

Integral CMS

Integral is a CMS for Rails 5+. The aim of Integral is to lower the barrier of entry in creating websites, using Ruby on Rails, with all the bells and whistles that users have now come to expect. Out of the box integral provides;

  • Backend features
    • Professional design
    • User authentication & authorization
    • Page & Post management with full WYSWIYG editing
    • Image management (w/ background image processing)
    • List management
    • Settings management
    • Activity tracking
  • Frontend features
    • Dynamic Pages
    • Integrated Blog
    • SEO Ready
    • Contact form processing w/ HTML emails
    • Sitemap generation
  • Find out more...

Getting Started

  1. Add the gem to your Gemfile and run bundle install gem 'integral'
  2. Mount the Integral engine routes in your application # config/routes.rb mount Integral::Engine, at: "/", as: 'integral' root to: 'integral/static_pages#home'
  3. Make sure you're app runs Integral seed data on setup # db/seeds.rb Integral::Engine.load_seed
  4. Setup database - Copy and run necessary migrations rake integral:install:migrations rake db:create rake db:migrate rake db:setup
  5. Run Integral install rake task (adds configuration initializers) rails generate integral:install

Voila! Start your rails server and you're ready to go! You can access the user only area at /admin



Bug reporting

If you discover a problem with Integral, we would love to know about it. Please use the GitHub issue tracker to contact us about it.

If you have discovered a security related bug, please do NOT use the GitHub issue tracker. Send an email to [email protected]

Looking for help

If you have any questions please use StackOverflow instead of the GitHub issue tracker.


We love contributers! Please check out the contributing guide for guidelines on how to proceed. Bug reports and pull requests are welcome on Github.


Integral is available as open source under the terms of the MIT License.