Browse the Ruby on Rails Community.

You are here: Browse Railsplugins Reverse Proxy Fix

Reverse Proxy Fix

=REVERSE PROXY PLUGIN Version 1.0.5.1 (March 25th, 2008)

===© 2006-2008 Brian Hogan

  1. #==Introduction
  2. This plugin is designed to allow your Rails application to reside behind a reverse proxy.
  3. When the plugin is configured and the application is running in production mode, any URLs generated
  4. by Rails helpers will automatically be prefixed with the host and path you specify. # #==Example Usage
  5. An organization may be interested in running a Rails application behind a reverse proxy such as Apache. However,
  6. any URLs generated by the Rails appliction would expose the proxy. #
  7. For example, a front-end server http://www.mydomain.com/app1/ might be mapped to http://backend.mydomain.com:3000/ #
  8. The plugin would be configured to prepend http://www.mydomain.com/app1 to all URLs generated by the application. # #==Usage and Configuration
  9. Install via Subversion using the Ruby script/plugin install command. In the root of your Rails application structure
  10. (where you can see the app/ vendor/ and public/ folders)
  11. execute the following command: #
  12. ruby script/plugin install http://svn.napcsweb.com/public/reverse_proxy_fix #
  13. You should be prompted to enter the base url of your front-end server when you install the plugin via script/plugin install. You
  14. should not include the trainling slash! For example:
  16. http://www.mydomain.com/typo #
  17. If that doesn’t work for some reason, you can run the install.rb script in vendor/plugins/reverse_proxy_fix. Or you can manually
  18. edit the file lib/config.rb and uncomment the BASE_URL line. (It should be the only line in the file. Enter the desired base url
  19. that you would like the plugin to prepend to any generated URLs. # #==Versions of Rails #
  20. This plugin supports Rails 1.x, Rails 1.2.x, and Rails 2.0 by using separate files for each Rails version
  21. During the installation you’ll need to tell the plugin which version to use. If this fails for some reason,
  22. simply rename the appropriate file to reverse_proxy_fix.rb
  23. * 116.rb (Rails 1.1.6 or below)
  24. * 123.rb (Rails 1.2.X)
  25. * 20.rb (Rails 2.X) #
  26. Then start your application in Production mode. The plugin is automatically disabled when you run in development mode, so you don’t
  27. need to do any special configurations to develop your application. #
  28. That’s it! #
  29. Limitations #
  30. First, asset hosts are disabled and overruled by this plugin. Your asset host base URL is set to the base url you specify. Modify the plugin to change this behavior. I am open to patches for this. #
  31. Second, in order to get named routes working in Rails 2.0 I took the shortcut and disabled route optimization. #
  32. Revisions #
  33. Version 1.0.5.1
  34. * Updated the readme version and fixed the installation script so it worked for platforms other than Windows (Thanks to Brian Candler for catching this and supplying a patch) #
  35. Version 1.0.5
  36. * Fixed the issue that prevented named routes from not working in Rails 2.0 by disabling named route optimization. #
  37. Version 1.0.4.1
  38. * Fixed the installer script to properly select Rails version. (Joshua Miller) #
  39. Version 1.0.4.0
  40. * Added support for Rails 2.0 – needs more testing #
  41. Version 1.0.3.2
  42. * Unified installer for all Rails versions again. #
  43. Version 1.0.3.1
  44. * Fixed an issue when using RESTful routing – plugin should no longer activate in dev mode. #
  45. Version 1.0.3
  46. * Added a rake task to configure the plugin
  47. * fixed a situation where the installer didn’t work in Rails 1.2.3
  48. * fixed a problem with request.request_uri not setting the base path.
  49. * Overloaded routing mechanism to avoid collisions with the modified request.request_uri
  50. * Tested with acts_as_authenticated #
  51. Version 1.0.2
  52. * Fixed issue where page caching does not work. The URL rewriting can now be turned off by sending t => true to any calls to url_for or link_to. (This is the method that caching uses to build the cached urls) #
  53. Version 1.0.1
  54. * Small bug fix to allow :only_path => false to work correctly when called on link_to and url_for #
  55. Version 1.0
  56. * Initial Release # #==License
  57. Copyright © 2006-2007 Brian Hogan
  59. Permission is hereby granted, free of charge, to any person obtaining
  60. a copy of this software and associated documentation files (the
  61. “Software”), to deal in the Software without restriction, including
  62. without limitation the rights to use, copy, modify, merge, publish,
  63. distribute, sublicense, and/or sell copies of the Software, and to
  64. permit persons to whom the Software is furnished to do so, subject to
  65. the following conditions: #
  66. The above copyright notice and this permission notice shall be
  67. included in all copies or substantial portions of the Software. #
  68. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
  69. EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  70. MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  71. NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  72. LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  73. OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  74. WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NOTE: This description has been extracted from the Plugin README and so the formatting may need updating to make browser friendly


Homepage: http://www.napcsweb.com/blog/2006/05/10/reverse-proxy-fix-plugin/