Typus User Guide

Typus is a control panel for Rails applications to allow trusted users edit structured content.

It’s not a CMS with a full working system but it provides a part of the system: authentication, permissions and basic look and feel for your websites control panel. So using Rails with Typus lets you concentrate on your application instead of the bits to manage the system.

Typus is the “old latin” word for type which stands for:

A category of people or things having common characteristics.

Key Features

  • Built-in Authentication and Access Control Lists.
  • CRUD and custom actions for your models on a clean interface.
  • Customizable and extensible templates.
  • Integrated paperclip and dragonfly attachments viewer.
  • Supports Rails 4.0 and 3.2.
  • Tested with SQLite3, MySQL and PostgreSQL.
  • MIT License, the same as Rails.

Support

You can directly participate in the support and development of Typus, including new features, by hiring our team to work on your project. We offer customization services for modules and extensions for a fee.

Send your inquiries to contact@typuscmf.com.

Installation

Before installing make sure your application does not have any controller under controllers/admin as all Typus controllers will be generated there.

To install Typus, edit the application Gemfile and add:

gem 'typus'

# Bundle edge Typus instead:
# gem 'typus', github: 'typus/typus'

Install the RubyGem using bundler:

bundle install

Typus expects to have models to manage, so run the generator in order to generate the required configuration files:

rails generate typus

Start the application server, go to http://0.0.0.0:3000/admin and follow the instructions.

By default Typus will not enable any authentication mechanism. If you want to add session authentication you need to run a generator and migrate your application database:

rails generate typus:migration
rake db:migrate

This generator creates a new model, AdminUser and adds some settings which will be stored under config/typus folder. You can see some options of this generator running the following command:

rails generate typus:migration -h

If you want to customize views you can copy default views to your application:

rails generate typus:views

To see a list of Typus related tasks run:

rake -T typus

Contribute

All of our hard work and help/support is free. We do have expenses to pay for this project and your donations do allow us to spend more time building and supporting the project.

Some interesting ways to contribute to the project:

  • Fork the project - Fork the project on GitHub and make it better.
  • Tell everybody about Typus - Let us know and we’ll link back to you as well.
  • Hire us to work on your next project - we build websites large and small.

Credits

Somehow involved in the project:

MIT License

Copyright (c) 2007-2014 Francesc Esplugas Marti

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Table Of Contents

Next topic

Initializers

This Page