You can use this project as a starting point for any Rails 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.
A complete walkthrough tutorial is available on the GitHub wiki:
The tutorial documents each step we 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.
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!).
- Visitors to the main application (example.com) can sign up (register) as users (email confirmation is needed).
- A registered user can visit their "account page" and see their own user name, email address, and a list of subdomains they've created.
- A registered user can create any number of subdomains.
- Registered users can delete any of their own subdomains.
- Registered users can change their own user name, email or password.
- Registered users can destroy their own account (including all dependent subdomains).
- Any visitor can visit a subdomain (mysite.example.com) and see a "site" home page.
- Any visitor can visit any subdomain. Each "site" home page has a link to a list of all other "sites."
- The application can be customized by adding functionality and links to the "site" home page.
- Administrators can visit the "admin" subdomain (admin.example.com) and view an administrative home page.
- The administrative home page (admin.example.com) can only be seen by a signed-in administrator.
- The administrative home page has a link to a list of administrators.
- Only an administrator can create a new administrator (no email confirmation is needed).
- Any administrator can change or delete another administrator.
- The application can be customized by enabling administrators to delete users or subdomains.
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).
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 will change significantly in Rails 3.0 so this application will likely not work with Rails 3.0.
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)
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/
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 [email protected]:fortuity/subdomain-authentication.git
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
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.
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: [email protected]
password: admin123
To sign in as the pre-configured user, (unless you've changed it) use
email: [email protected]
password: user123
You should delete or change the pre-configured logins before you deploy your application.
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).
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.
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.
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.
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.
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.
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.
Daniel Kehoe (http://danielkehoe.com/) implemented the application and wrote the tutorial.
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.