Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
For version 4.0 (currently in beta), see [V4.0] Home
BrowserCMS is a general purpose, open source Web Content Management System (CMS), written in Ruby on Rails. It is designed to support three distinct groups of people:
- Non-technical web editors who want a humane system to manage their site, without needing to understand what HTML or even Rails is.
- Designers who want to create large and elegantly designed websites with no artificial constraints by the CMS.
- Developers who want create CMS driven websites for their clients, or add a CMS to their Rails applications.
- There is another sequence of reading these documents, as given by the numbers in parenthesis.
Documentation / Guides
- Getting Started – (1) Installing BrowserCMS and creating your first project.
- User's Manual – (5) How site builders can use the user interface to create sites.
- Upgrading a BrowserCMS Project – (2) How to upgrade a project or module to a newer version.
- Deployment Guide – How to configure your production server (using Apache/Passenger)
- Articles – A list of articles contributed by the Community on how to use, customize and extend BrowserCMS.
- API Docs – YARD API documents for the latest version of the project.
- Proposals – A landing page for proposals that would be significant changes or improvements to either the Core CMS or modules.
- Adding BrowserCMS to an Existing Rails project – A guide to ‘CMSifying’ your existing Rails appliciation
- Setting up Mobile Sites – A guide to configuring BrowserCMS to serve mobile content. (Coming in v3.5, see bcms_mobile until then.)
- Content Blocks – (6) How to defining new content types for your site.
- Portlets – (7) How to fetch and dynamically display content
- Templates – (3) How to create a theme/design for a site.
- Building BrowserCMS from Edge – How to work with the very latest version of BrowserCMS from github
- Controllers with Authentication – How to create ActionControllers which use CMS authentication
- Working with the Content API – Understanding a few of the ‘gotchas’ between ActiveRecord and Content Blocks.
- Module List – Find other modules to add to your BrowserCMS project.
- Installing a Module – (4) How to add new functionality (modules) to your project
- Building Modules – Creating your own modules to share with the community.
Reference guides for older versions (BrowserCMS 3.1) are still available.
Code Tips / Snippets
Contributing to the Project
- Want to report a bug?
- Want to discuss a new idea/feature?
- Roadmap – An overview of where the project is going, and what might come next.
If you have questions, you can also find us in a few places:
- Our google group/mailing list
- On Twitter at @browsercms
- In IRC, at irc.freenode.net, channel #browsercms