Skip to content
This repository

An example Rails 2.3 web app with subdomains and authentication (using Devise). With a tutorial.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 app
Octocat-spinner-32 config
Octocat-spinner-32 db
Octocat-spinner-32 doc
Octocat-spinner-32 lib
Octocat-spinner-32 public
Octocat-spinner-32 script
Octocat-spinner-32 test
Octocat-spinner-32 vendor
Octocat-spinner-32 .gems
Octocat-spinner-32 .gitignore
Octocat-spinner-32 README
Octocat-spinner-32 README.markdown
Octocat-spinner-32 Rakefile
README.markdown

Subdomain-Authentication

You can use this project as a starting point for any Rails 2.3.5 web application that requires subdomains and authentication. User management and authentication is implemented using the Devise gem. The subdomain_routes gem implements subdomains and routing.

UPDATE: In Rails 3 it's much easier to implement subdomains than in Rails 2 (no plugin required). For a complete example implementation of Rails 3 subdomains with authentication, using Devise, with a detailed tutorial, see: http://github.com/fortuity/rails3-subdomain-devise

"Building It" Tutorial

A complete walkthrough tutorial is available on the GitHub wiki:

View the Tutorial

The tutorial documents each step I followed to create the application. Every step is documented concisely, so a complete beginner can create this application without any additional knowledge. However, no explanation is offered for any of the steps, so if you are a beginner, you’re advised to look for an introduction to Rails elsewhere.

If you simply wish to modify the application for your own project, you can download the application and set it up as described below, without following the tutorial.

Use Cases

What Is Implemented

This application implements a particular scenario where subdomains are required. There is a "main" domain where anyone can visit and create a user account. There is an "admin" subdomain for the exclusive use of administrators. And registered users can create any number of subdomains which could host blogs or other types of sites. This approach is familiar to users of sites such as wordpress.com and can be called "blog-style subdomains in Rails" (is there a better name? let me know!).

Main Domain ("Promotional Site") Functionality

  1. Visitors to the main application (example.com) can sign up (register) as users (email confirmation is needed).
  2. A registered user can visit their "account page" and see their own user name, email address, and a list of subdomains they've created.
  3. A registered user can create any number of subdomains.
  4. Registered users can delete any of their own subdomains.
  5. Registered users can change their own user name, email or password.
  6. Registered users can destroy their own account (including all dependent subdomains).

Subdomain ("User Sites") Functionality

  1. Any visitor can visit a subdomain (mysite.example.com) and see a "site" home page.
  2. Any visitor can visit any subdomain. Each "site" home page has a link to a list of all other "sites."
  3. The application can be customized by adding functionality and links to the "site" home page.

Admin Subdomain Functionality

  1. Administrators can visit the "admin" subdomain (admin.example.com) and view an administrative home page.
  2. The administrative home page (admin.example.com) can only be seen by a signed-in administrator.
  3. The administrative home page has a link to a list of administrators.
  4. Only an administrator can create a new administrator (no email confirmation is needed).
  5. Any administrator can change or delete another administrator.
  6. The application can be customized by enabling administrators to delete users or subdomains.

What Is Not Implemented

Subdomains are commonly used to host a user's account in a scenario often called "Basecamp-style subdomains in Rails". Visitors to the main site can create a user account which is then hosted at a subdomain that matches their user name. Each user has only one subdomain and when they log in, all their activity is confined to their subdomain. A user's home page and account info is accessed only through the subdomain that matches their user name. This approach is NOT implemented in this application (if you build an example of this, let me know and I will add a link here).

Dependencies

This application requires Rails version 2.3.5. Some of the code shown here will not work in older versions of Rails.

This application was written before the release of Rails 3.0. Things changed significantly in Rails 3.0 so this application will not work with Rails 3.0. Instead, for a complete example implementation of Rails 3 subdomains with authentication, using Devise, with a detailed tutorial, see: http://github.com/fortuity/rails3-subdomain-devise

To use this application, you need to install

  • The Ruby language ruby (version 1.8.7 or newer)
  • The RubyGems packaging system (version 1.3.5 or newer)
  • A working installation of SQLite (preferred), MySQL, or PostgreSQL
  • Rails (version 2.3.5 or newer)

Gems Required

The application uses the following gems:

  • haml (version 2.2.17)
  • will_paginate (version 2.3.12)
  • formtastic (version 0.9.7)
  • warden (version 0.9.5)
  • devise (version 1.0.3)
  • inherited_resources (version 1.0.3)
  • subdomain_routes (version 0.3.1)
  • friendly_id (version 2.2.7)

Note that the devise gem must be version 1.0.3 and the inherited_resources gem must be version 1.0.3. Newer versions of these gems only support Rails 3 and are NOT backward compatible.

All gems are on gemcutter, so you need to add gemcutter to your sources if you haven’t yet:

$ sudo gem sources -a http://gemcutter.org/

Download

The source code is managed with Git (a version control system) and hosted at GitHub. You'll need Git on your machine (install it from http://git.or.cz/).

You can download the app ("clone the repository") with the command

$ git clone git@github.com:fortuity/subdomain-authentication.git

Getting Started

Configure Email

Configure email by modifying

config/initializers/devise.rb

and setting the return email address for emails sent from the application.

You may need to set values for your mailhost in

config/environments/development.rb
config/environments/production.rb

Set Up the Database

You can use the default database settings if you're using SQLite.

If you're using MySQL, you'll need to edit the file

config/database.yml

Set up the database by running

$ rake db:create
$ rake db:migrate
$ rake sdauth:setup

Running the "sdauth:setup" rake task sets up an initial administrator and user. You can modify the file

lib/tasks/setup.rake

if you wish to change the administrator and user logins before you run the migration.

Launch the Application

Start the server

$ script/server

and go to http://localhost:3000/.

To sign in as the pre-configured administrator, (unless you've changed it) use

email: admin@test.com
password: please

To sign in as one of the pre-configured users, (unless you've changed it) use

email: firstuser@test.com
password: please

You should delete or change the pre-configured logins before you deploy your application.

Deploying to Heroku

Set Up Heroku

For your convenience, here are instructions for deploying your app to Heroku. Heroku provides low cost, easily configured Rails application hosting.

To deploy this app to Heroku, you must have a Heroku account. If you need to obtain one, visit http://heroku.com/ to set up an account. After you set up a Heroku account, install the Heroku gem:

$ sudo gem install heroku

Add your public key immediately after installing the heroku gem so that you can use git to push or clone Heroku app repositories. See http://docs.heroku.com/heroku-command for details.

Create Your Application on Heroku

Use the Heroku create command to create and name your new app:

$ heroku create _myapp_

Heroku Add-ons and DNS Configuration

You will need the following Heroku add-ons to deploy your app using subdomains with your own custom domain:

  • Custom Domains (free)
  • Custom Domains + Wildcard ($5 per month)
  • Zerigo DNS Tier 1 ($7 per month)

To enable the add-ons, you can use the Heroku web interface or you can enter the following commands:

$ heroku addons:add custom_domains

$ heroku domains:add mydomain.com

$ heroku addons:add wildcard_domains

$ heroku domains:add *.mydomain.com

$ heroku addons:add zerigo_dns:tier1

If you are using the Zerigo DNS service, you will need to set the nameserver with your domain registrar. It can take a few minutes (or longer) for DNS changes to propagate. When DNS is set properly, you should be able to visit mydomain.com or test.mydomain.com in your web browser and see the Heroku default page:

Heroku | Welcome to your new app!

You can check that everything has been added correctly by running:

$ heroku info --app myapp

Set Up Your Application on Heroku

Push your application to Heroku:

$ git push heroku master

Set up your Heroku database:

$ heroku rake db:migrate

Initialize your application database:

$ heroku rake sdauth:setup

Visit Your Site

Open your Heroku site in your default web browser:

$ heroku open

Troubleshooting

If you get errors, you can troubleshoot by reviewing the log files:

$ heroku logs

Customizing

Devise provides a variety of features for implementing authentication. See the Devise documentation for options.

This application provides no useful functionality apart from implementing subdomains and authentication. You can begin adding functionality by modifying the Site model (for example, to create a blog for each subdomain).

Testing

The application does not include tests (of either Test::Unit or RSpec varieties). It relies on Devise which includes extensive tests. This application is intended to be a basis for your own customized application and (in most cases) you will be writing your own tests for your required behavior.

Documentation and Support

You can find documentation for Devise at http://github.com/plataformatec/devise. There is an active Devise mailing list and you can submit Devise issues at GitHub.

You can find documentation for subdomain_routes at http://github.com/mholling/subdomain_routes/. There is no active forum for support but you can post to Matthew Hollingworth's blog with questions and submit subdomain_routes issues at GitHub.

The Devise community and subdomain_routes author are your best source for answers to questions about authentication and subdomain implementation. For specific issues with this application, you can submit bug reports at GitHub. If you want to post complaints (or praise!) about this application, there is a forum for this application at Get Satisfaction.

This application is provided without additional documentation or support.

Implementation and Architectural Issues

I've tried to follow current Rails best practices (to the extent I'm aware of them). If you see errors in approach or have suggestions for improvements, I'd like to hear from you so that I can make corrections.

Namespacing

This application doesn't use namespacing. It is "flat." All controllers are in the controllers directory; there are no subdirectories. The same is true of views; each set of views is in its own subdirectory; there are no hierarchies of views nested in additional subdirectories.

One could implement this application with namespacing by moving admin controllers to an app/controllers/admin directory and moving admin view subdirectories to an app/views/admin directory. Controllers and views for the main domain or subdomains could also be moved to subdirectories. This offers the benefit of organizing the code but introduces complexity. For an example application, I've decided namespacing is unnecessarily complex.

If you implement a namespaced version of this application, please let me know and I'll provide a link so others can see how it is done.

FAQ

Q. When I'm signed in as a user on the main domain, I have to sign in again when I visit any subdomain. How can I maintain my signed-in status across all subdomains?

A. Your web browser is setting a cookie (containing the session ID) separately for each domain. To maintain a user login across all domains, you’ll want to configure your session to work across all your subdomains. You can do this in your environment files by setting

config.action_controller.session[:session_domain]

See the details at http://github.com/mholling/subdomain_routes/.

Contributing

If you make improvements to this application, please share with others.

  • Fork the project on GitHub.
  • Make your feature addition or bug fix.
  • Commit with Git.
  • Send the author a pull request.

If you add functionality to this application, create an alternative implementation, or build an application that is similar, please contact me and I'll add a note to the README so that others can find your work.

Similar Applications

For a complete example implementation of Rails 3 subdomains with authentication, using Devise, with a detailed tutorial, see: http://github.com/fortuity/rails3-subdomain-devise

For a similar application (for Rails 2.3) that uses Authlogic and Subdomain_fu, see authlogic_subdomain_fu_startup_app.

For a simple Devise example (without subdomains), see plataformatec/devise_example.

Credits

Daniel Kehoe (http://danielkehoe.com/) implemented the application and wrote the tutorial.

License

Public Domain Dedication

This work is a compilation and derivation from other previously released works. With the exception of various included works, which may be restricted by other licenses, the author or authors of this code dedicate any and all copyright interest in this code to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this code under copyright law.

Something went wrong with that request. Please try again.