https://github.com/radar/houser
Lightweight multitenancy gem for Rails 3 and Rails 4
https://github.com/radar/houser
Last synced: 2 months ago
JSON representation
Lightweight multitenancy gem for Rails 3 and Rails 4
- Host: GitHub
- URL: https://github.com/radar/houser
- Owner: radar
- License: mit
- Created: 2014-01-25T00:42:52.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-11-28T00:52:06.000Z (over 5 years ago)
- Last Synced: 2025-02-28T06:58:34.288Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 410 KB
- Stars: 32
- Watchers: 5
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Houser
This is the multitenancy gem that is used in the Multitenancy with Rails book as an alternative method to PostgreSQL schemas which can have their own set of problems (such as backups taking an inordinately long time).
Houser provides you with two Rack environment variables which can then be used in your application to scope resources correctly. That is all it does for the time being, and it will probably do more in the future.
## Installation
Add this line to your application's Gemfile:
gem 'houser'
And then execute:
$ bundle
In `config/application.rb`, put this line:
``` ruby
config.middleware.use Houser::Middleware,
:class_name => 'Model'
```
Where 'Model' is the class that you're scoping by.
If you're using a TLD like `.co.uk` instead of `.com`, you will need to specify `tld_length` too:
``` ruby
config.middleware.use Houser::Middleware,
:class_name => 'Model',
:tld_length => 2
```
## Usage
There are two rack environment variables set by the Houser middleware that you can use throughout your application to scope resources.
If no object is found for the subdomain the request is received on, both of these variables will be nil.
### `env['Houser-Subdomain']`
The complete subdomain of the request. The following domains have the following subdomains:
* `sub1.example.com => sub1`
* `sub2.sub1.example.com => sub2.sub1`
* `sub1.example.co.uk => sub1`
* `sub2.sub1.example.co.uk => sub2.sub1`
### `env['Houser-Object']`
The instance of the Class that is found based on the subdomain.
## Contributing
Please see [CONTRIBUTING.md](https://github.com/radar/houser/CONTRIBUTING.md)