![Alchemy CMS](http://alchemy-cms.com/assets/alchemy_logo.svg) [![Gem Version](https://badge.fury.io/rb/alchemy_cms.png)](http://badge.fury.io/rb/alchemy_cms) [![Build Status](https://travis-ci.org/magiclabs/alchemy_cms.svg?branch=master)](https://travis-ci.org/magiclabs/alchemy_cms) [![Code Climate](https://codeclimate.com/github/magiclabs/alchemy_cms.png)](https://codeclimate.com/github/magiclabs/alchemy_cms) [![Coverage Status](https://coveralls.io/repos/magiclabs/alchemy_cms/badge.png?branch=master)](https://coveralls.io/r/magiclabs/alchemy_cms?branch=master) About ----- Alchemy is the most powerful, userfriendly and flexible Rails CMS. Read more on the [website](http://alchemy-cms.com) and in the [guidelines](http://guides.alchemy-cms.com). **This master branch is a development branch that can contain bugs. For productive environments you should use the [current Ruby gem version](http://rubygems.org/gems/alchemy_cms/versions/2.7.2), or the [latest stable branch (2.7-stable)](https://github.com/magiclabs/alchemy_cms/tree/2.7-stable).** Features -------- - Highly flexible Templating - Gorgious End-User centric interface - Multilingual - Multidomain - SEO friendly - Access Control - RSS Feeds - Contactforms - Attachments and downloads - Powerful image rendering - Extendable - Integrates in existing Rails Apps - Caching - BSD License - Hostable on any Server that supports Ruby on Rails, a SQL Database and ImageMagick Rails Version ------------- **This version of Alchemy CMS runs with Rails 4 (including 4.1)** If you are looking for a Rails 3.2 compatible version check the [2.7-stable branch](https://github.com/magiclabs/alchemy_cms/tree/2.7-stable). If you are looking for a Rails 3.1 compatible version check the [2.1-stable branch](https://github.com/magiclabs/alchemy_cms/tree/2.1-stable). If you are looking for a Rails 3.0 compatible version check the [2.0-stable branch](https://github.com/magiclabs/alchemy_cms/tree/2.0-stable). If you are looking for a Rails 2.3 compatible version check the [1.6-stable branch](https://github.com/magiclabs/alchemy_cms/tree/1.6-stable). Ruby Version ------------ Alchemy runs with Ruby >= 1.9.3 (including Ruby 2.0 and 2.1). For a Ruby 1.8.7 compatible version use the [2.3-stable branch](https://github.com/magiclabs/alchemy_cms/tree/2.3-stable). Installation ------------ ### As a standalone project #### 1. Use the installer: gem install alchemy_cms alchemy new my_magicpage cd my_magicpage Run bundle install to finish installation process. #### 2. Start the local server: bin/rails server #### 3. Switch to your browser: Open `http://localhost:3000` and follow the on screen instructions. ### Into an existing Rails project #### 1. Add the Alchemy gem: In your App's Gemfile: gem 'alchemy_cms', github: 'magiclabs/alchemy_cms', branch: 'master' #### 2. Install Alchemy into your app: Run in terminal: bundle install bin/rake alchemy:install ### Authentication User Model With Version 3.0 we extracted the Alchemy user model [into its own gem](https://github.com/magiclabs/alchemy-devise). In order to get the former Alchemy user model back, add the following gem into your Gemfile: gem 'alchemy-devise', github: 'magiclabs/alchemy-devise', branch: 'master' Run in terminal: bundle install bin/rake alchemy_devise:install:migrations db:migrate **In order to use your own user model, you can add e.g.** # config/initializers/alchemy.rb Alchemy.user_class_name = 'YourUserClass' Alchemy.login_path = '/your/login/path' Alchemy.logout_path = '/your/logout/path' The only thing Alchemy needs to know from your user model is the `alchemy_roles` method. This method has to return an `Array` or `ActiveRecord::Relation` with at least one of the following roles: * `member` * `author` * `editor` * `admin` Example: def alchemy_roles self.admin? %w(admin) end end Deployment ---------- Alchemy ships with a generator that creates a Capistrano `config/deploy.rb` file, which takes care of everything you need to deploy an Alchemy site. So, if you don't have your own deploy file, we encourage you to use this generator: $ bin/rails g alchemy:deploy_script If you have your own Capistrano receipts, you should require the Alchemy tasks in your app's `config/deploy.rb` file: # deploy.rb require 'alchemy/capistrano' If you don't use Capistrano you have to **make shure that the `uploads`, `tmp/cache/assets`, `public/assets` and `public/pictures` cache folders get shared** between deployments, otherwise you **will loose data**. Please take a look into the `lib/alchemy/capistrano.rb` file, to see how to achieve this. Upgrading --------- After updating the Alchemy gem in your App, you should run the upgrader. Run in terminal: bin/rake alchemy:upgrade Tips ----- - Read the guidelines: http://guides.alchemy-cms.com. - Read the documentation: http://rubydoc.info/github/magiclabs/alchemy_cms - Ask the community: http://groups.google.com/group/alchemy-cms Getting Help ------------ * If you have bugs, please use the [issue tracker on Github](https://github.com/magiclabs/alchemy_cms/issues). * For Q&A and general usage, please use the [User Group](http://groups.google.com/group/alchemy-cms) or the IRC channel. * New features should be discussed on our [Trello Board](https://trello.com/alchemycms). *PLEASE* don't use the Github issues for new features. Resources --------- * Homepage: * Live-Demo: (user: demo, password: demo123) * API Documentation: * Issue-Tracker: * Sourcecode: * User Group: * IRC Channel: #alchemy_cms on irc.freenode.net * Discussion Board: Authors --------- * Thomas von Deyen: * Robin Böning: * Marc Schettke: * Hendrik Mans: * Carsten Fregin: License ------- * BSD: