An extendable Ruby on Rails CMS that supports Rails 4.2+
Ruby HTML CSS JavaScript CoffeeScript
Failed to load latest commit information.
bin Move refinerycms executable to exe/. Apr 9, 2015
certs Sign the gems. Jul 18, 2016
config Added spring support for slightly faster development. Dec 5, 2014
core Fixed admin menu items duplicating after extensions code changing (#3234 Jul 26, 2016
doc/guides Update How to get help guide (#3224) Jul 19, 2016
exe Move refinerycms executable to exe/. Apr 9, 2015
images Sign the gems. Jul 18, 2016
lib Baby steps in removing authentication from refinery. (woohoo!) Jul 18, 2015
pages Sign the gems. Jul 18, 2016
resources Add resources translations to ES Jul 20, 2016
spec Allow spec retry count to be environment specific, and disabled by de… Apr 12, 2016
tasks authentication is no longer part of this repo Sep 19, 2015
templates/refinery Update version of refinerycms-acts-as-indexed Jun 29, 2016
testing Sign the gems. Jul 18, 2016
tmp/pids Add tmp/pids folder. Jun 12, 2012
.gitignore Adding byebug_history to .gitignore Apr 12, 2016
.pullreview.yml Fix Malformed PullReview conf file Dec 8, 2014
.rspec Randomly order specs. Nov 26, 2013
.travis.yml Rails 5 doesn't allow Rubies before 2.2.2, let's not test them. (#3177) Jun 5, 2016
.yardopts authentication is no longer part of this repo Sep 19, 2015
Gemfile Update version of refinerycms-acts-as-indexed Jun 30, 2016
Rakefile Update Rails 3.2 -> Rails 4.0 APIs. Sep 3, 2013
changelog.md Add release date for 3.0.4 Jul 18, 2016
config.ru Allow use of puma.io webserver Mar 30, 2012
contributing.md Added `bundle exec` to make examples consistent Dec 5, 2014
license.md the Resolve Digital website now runs on HTTPS. Link directly to avoid… Mar 12, 2016
readme.md Docs: ImageMagick vulnerability CVE-2016–3714 May 9, 2016
refinerycms.gemspec Sign the gems. Jul 18, 2016

readme.md

Refinery CMS

An open source content management system for Rails 4.2+

More information at http://refinerycms.com

Build Status Code Climate Coverage Status

You can chat with us using Gitter:

Gitter chat

Requirements

  • Bundler
  • ImageMagick
    • ⚠️ Warning: ImageMagick currently has a serious security vulnerability, CVE-2016–3714. After installing, you must disable certain features in ImageMagick's policy configuration. Please see the following for details:
    • Mac OS X users should use homebrew's brew install imagemagick or the magick-installer.

How to

Getting Started

If you're new to Refinery, start with this guide:

If you want to use Rails 4.2.x with Refinery now, install using this template:

rails new app_name -m http://refinerycms.com/t/edge

What's it good at?

Refinery is great for sites where the client needs to be able to update their website themselves without being bombarded with anything too complicated.

Unlike other content managers, Refinery is truly aimed at the end user making it easy for them to pick up and make changes themselves.

For developers

  • Easily customise the look to suit the business.
  • Extend with custom extensions to do anything Refinery doesn't do out of the box.
  • Sticks to "the Rails way" as much as possible; we don't force you to learn new templating languages.
  • Uses jQuery for fast and concise Javascript.

Demo

Wanna see Refinery for yourself? Try the demo.

Help and Documentation

Features

Pages

  • Easily edit and manage pages with a visual editor.
  • Manage your site's structure.

Images & Files

  • Easily upload and insert images.
  • Upload and link to resources such as PDF documents.
  • Uses the popular Dragonfly.
  • Supports storage on Amazon S3.

Authentication & Users

  • Manage who can access Refinery.
  • Control which extensions each user has access to.
  • Uses the popular Devise.

Custom Extensions

Extend Refinery easily by running the Refinery extension generator. For help run the command without any options:

rails generate refinery:engine

Popular Extensions

  • Blog - A simple blogging extension that supports posts, categories and comments with optional moderation support.
  • Portfolio - manage groups of images like an image gallery.
  • News - post and manage news items.
  • Inquiries - simple contact form that notifies you and customer when an inquiry is made.

Full extension list here

Example Site Showcase

List here (add your link when you're done)

Contributing

See contributing.md and Contributing to Refinery guide for details about contributing and running test.

License

Refinery is released under the MIT license. See the license.md file for details.

Credits

Many of the icons used in Refinery CMS are from the wonderful Silk library by Mark James.