README.md

RailsAdmin

RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.

Announcements

[Action required] Security issue

RailsAdmin 2.0.1, 2.0.0 and up to 1.4.2 have been reported to have XSS vulnerability. We strongly recommend that you upgrade RailsAdmin to 2.0.2 (and higher) or 1.4.3 as soon as possible, if you are on those versions. See d72090ec for the detail.

Getting started

• Check out the docs.
• Try the live demo. (Source code)

Features

• CRUD any data with ease
• Custom actions
• Automatic form validation
• Search and filtering
• Export data to CSV/JSON/XML
• Authentication (via Devise or other)
• Authorization (via CanCanCan or Pundit)
• User action history (via PaperTrail)
• Supported ORMs
  • ActiveRecord
  • Mongoid

Installation

1. On your gemfile: gem 'rails_admin', '~> 2.0'
2. Run bundle install
3. Run rails g rails_admin:install
4. Provide a namespace for the routes when asked
5. Start a server rails s and administer your data at /admin. (if you chose default namespace: /admin)

Configuration

Global

In config/initializers/rails_admin.rb:

Details

To begin with, you may be interested in setting up Devise, CanCanCan or Papertrail!

Per model

class Ball < ActiveRecord::Base
  validates :name, presence: true
  belongs_to :player

  rails_admin do
    configure :player do
      label 'Owner of this ball: '
    end
  end
end

Details: Models, Groups, Fields

Support

If you have a question, please check this README, the wiki, and the list of known issues.

If you still have a question, you can ask the official RailsAdmin mailing list.

If you think you found a bug in RailsAdmin, you can submit an issue.

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

• Ruby 2.2
• Ruby 2.3
• Ruby 2.4
• Ruby 2.5
• Ruby 2.6
• Ruby 2.7
• Ruby 3.0
• JRuby