rails-reverse-proxy/README.md

78 lines
1.6 KiB
Markdown
Raw Normal View History

2015-06-05 02:24:05 +00:00
# rails-reverse-proxy
2015-06-05 03:54:26 +00:00
Gives you the ability to reverse proxy within Rails.
2015-06-05 02:24:05 +00:00
## Installation
2015-06-05 03:54:26 +00:00
You know the drill. In your Gemfile, have the line
```ruby
gem 'rails-reverse-proxy'
```
Then (you guessed it!)
```
$ bundle
```
## Usage
An example usage of this gem is hosting a WordPress site on a path within your Rails application, such as `/blog`. To do this, you'll need something like
```ruby
class WordpressController < ApplicationController
include ReverseProxy::Controller
def index
# Assuming the WordPress server is being hosted on port 8080
reverse_proxy "http://localhost:8080" do |config|
# We got a 404!
config.on_missing do |code, response|
redirect_to root_url and return
end
# There's also other callbacks:
# - on_set_cookies
# - on_response
# - on_set_cookies
# - on_success
# - on_redirect
# - on_missing
# - on_error
# - on_complete
end
end
end
```
Then in your `routes.rb` file, you should have something like
```ruby
match 'blog/*path' => 'wordpress#index', via: [:get, :post, :put, :patch, :delete]
2015-06-05 02:24:05 +00:00
```
2015-06-05 03:54:26 +00:00
You can also pass options into `reverse_proxy`
```ruby
reverse_proxy "http://localhost:8000", path: "custom-path", headers: { 'X-Foo' => "Bar" }
2015-06-05 02:24:05 +00:00
```
2015-06-05 03:54:26 +00:00
Sorry if these instructions are sparse. Feel free to reach out or read the source!
## Contributing
All pull requests will become first class citizens.
2015-08-28 06:27:42 +00:00
## Thanks
Special thanks to our contributors!
- [miyukki](https://github.com/miyukki)
2015-06-05 02:24:05 +00:00
## Copyright
Copyright (c) 2015 James Hu. See LICENSE.txt for
further details.