Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

An extendable Ruby on Rails 'CMS framework' that supports Rails 3

tag: 0.9.5.31

Fetching latest commit…

Cannot retrieve the latest commit at this time

readme.md

Refinery CMS

An open source Ruby on Rails content management system for small business.

For more screenshots, example sites & high level information: http://refinerycms.com

Refinery Dashboard

What it's good at?

Refinery is great for small business 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

Refinery makes it easy to:

  • Get a small business site up and running ridiculously quickly
  • Theme and customise the look to suit the business
  • Extend with custom plugins to do anything Refinery doesn't do out of the box
  • Tries to stick to "the Rails way" as much as possible

Requirements

Refinery runs using a number of gems which (as of Refinery version 0.9.5.29) are outlined below:

Other dependancies

Installing and Setting Up Refinery

1. Get the Refinery code

Install the Gem

gem install refinerycms --source http://gemcutter.org
refinery /path/to/project

Or, clone Refinery's Git repository

git clone git://github.com/resolve/refinerycms.git mynewsite.com
cd ./mynewsite.com
git remote rm origin
git remote add origin git@github.com:you/yournewsite.git
mv ./config/database.yml.example ./config/database.yml

2. Configuration

Firstly, edit config/database.yml to reflect your database server details.

Next create your database and fill it with Refinery's default data:

rake db:setup

After your database exists, you'll need to install the gems that Refinery depends on. You can do this by running:

rake gems:install

3. Starting up your site

ruby script/server

Now visit http://localhost:3000 and your site should be running.

You will be prompted to setup your first user.

Help and Developer Documentation

Setting Up on Heroku

If you're using Heroku you will want to put

USE_S3_BACKEND = true

in your config/production.rb file.

Updating to the latest Refinery

When using the gem

Simply run the command:

refinery-update-core /path/to/project/root/

and the up-to-date core files will be copied from the latest gem into your project.

When using Git

You can update by running these commands:

git remote add refinerycms git://github.com/resolve/refinerycms.git
git pull refinerycms master

This will pull in all of the updated files in the project and may result in some merge conflicts which you will need to resolve.

What comes included with Refinery

Pages

Images & Resources

  • Easily upload and insert images
  • Upload and link to resources like PDF documents

Inquiries

  • Collect inquiries from a contact form
  • Manage your inquiries and be notified when new ones come in

News

  • Post news about your company and update your visitors

Settings

  • Manage the behaviour of Refinery

Dashboard

  • Get an overview of what has been updated recently

...Want more?

Extend Refinery easily by running the Refinery generator

ruby script/generate refinery

to get help on how to use that.

What about a portfolio?

Check out the portfolio plugin gem

License

Refinery is released under the MIT license and is copyright (c) 2005-2009 Resolve Digital Ltd.

A copy of the MIT license can be found in the license.md file.

Something went wrong with that request. Please try again.