用于定义标准主机名的机架中间件。
Rack middleware that lets you define a single host name as the canonical host for your application. Requests for other host names will then be redirected to the canonical host.
Add this line to your application’s Gemfile:
gem 'rack-canonical-host'And then execute:
$ bundleOr install it yourself as:
$ gem install rack-canonical-hostFor most applications, you can insert the middleware into the config.ru file
in the root of the application.
Here’s a simple example of what the config.ru in a Rails application might
look like after adding the Rack::CanonicalHost middleware.
require 'rack/canonical_host'
require ::File.expand_path('../config/environment', __FILE__)
use Rack::CanonicalHost, 'example.com'
run YourRailsApp::ApplicationIn this case, any requests coming in that aren't for the specified host,
example.com, will be redirected, keeping the requested path intact.
You probably don't want your redirect to happen when developing locally. One way to prevent this from happening is to use environment variables in your production environment to set the canonical host name.
With Heroku, you would do this like so:
$ heroku config:add CANONICAL_HOST=example.comThen, can configure the middleware like this:
use Rack::CanonicalHost, ENV['CANONICAL_HOST'] if ENV['CANONICAL_HOST']Now, the middleware will only be used if a canonical host has been defined.
If you’d like the middleware to ignore certain hosts, use the :ignore option,
which accepts a string, a regular expression, a proc, or an array of those
objects.
use Rack::CanonicalHost, 'example.com', ignore: 'api.example.com'In this case, requests for the host api.example.com will not be redirected.
Alternatively, you can pass a block whose return value will be used as the canonical host name.
use Rack::CanonicalHost do |env|
case env['RACK_ENV'].to_sym
when :staging then 'staging.example.com'
when :production then 'example.com'
end
endIf you want it to react only on specific hosts within a multi-domain
environment, use the :if option, which accepts a string, a regular
expression, a lambda or proc, or an array of those objects.
use Rack::CanonicalHost, 'example.com', if: /.*\.example\.com/
use Rack::CanonicalHost, 'example.org',
if: ->(uri) { uri.host == 'www.example.org' }To avoid browsers indefinitely caching a 301 redirect, it’s a sensible idea
to set an expiry on each redirect, to hedge against the chance you may need to
change that redirect in the future.
# Leave caching up to the browser (which could cache it indefinitely):
use Rack::CanonicalHost, 'example.com'
# Cache the redirect for up to an hour:
use Rack::CanonicalHost, 'example.com', cache_control: 'max-age=3600'
# Prevent caching of redirects:
use Rack::CanonicalHost, 'example.com', cache_control: 'no-cache'git checkout -b my-new-feature)git commit -am 'Add some feature.')git push origin my-new-feature)Thanks to the following people who have contributed patches or helpful suggestions:
Copyright © 2009 Tyler Hunt.
Released under the terms of the MIT license. See LICENSE for details.
暂无开放 Issues,或尚未同步最近议题。