Refinery CMS

An open source content management system for Rails 6.1+ through 8.1+

You can deploy an example app to Heroku:

Note that some of our docs in this README are out of date, and our website is not currently live. Please refer to our GitHub repository for the current status and instructions. Guides can be found in the doc/guides folder.

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:
    • https://imagetragick.com/
  • Mac OS X users should use homebrew's brew install imagemagick or the magick-installer.

How to

• Install Refinery CMS
• Install Refinery CMS on Heroku
• Contribute to Refinery CMS

Getting Started

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

• Getting Started

For Rails 5.1+ support, you can use version 4.0.x using this template:

rails new app_name -m https://www.refinerycms.com/t/4.0.0

For Rails 4.2.x support, you can use version 3.0.x using this template:

rails new app_name -m https://www.refinerycms.com/t/3.0.6

You can also install the edge version for the latest code using this template:

rails new app_name -m https://www.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 now, for fast and concise Javascript.

Help and Documentation

• Getting Started
• Google Group Discussion
• GitHub repository
• Developer/API documentation
• Twitter Account

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 CMS 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.