README

   1 = UnXF - Un-X-Forward* the Rack environment
   2
   3 Rack middleware to remove "HTTP_X_FORWARDED_FOR" in the Rack environment and
   4 replace "REMOTE_ADDR" with the value of the original client address.
   5
   6 This uses the "rpatricia" RubyGem to filter out spoofed requests from
   7 clients outside your LAN.  The list of trusted address defaults to
   8 private LAN addresses defined RFC 1918 and those belonging to localhost.
   9
  10 This will also read "HTTP_X_FORWARDED_PROTO" and set "rack.url_scheme"
  11 to "https" if the "X-Forwarded-Proto" header is set properly and sent
  12 from a trusted address chain.
  13
  14 == Install
  15
  16 If you use RubyGems:
  17
  18     gem install unxf
  19
  20 You will need a C compiler and Ruby development headers to install the
  21 "rpatricia" RubyGem if it is not already installed.
  22
  23 === Hacking
  24
  25 You can get the latest source via git from the following locations:
  26
  27 * git clone git://bogomips.org/unxf.git
  28 * git clone git://repo.or.cz/unxf.git (mirror)
  29
  30 You may browse the code from the web and download the latest snapshot
  31 tarballs here:
  32
  33 * http://bogomips.org/unxf.git
  34 * http://repo.or.cz/w/unxf.git (gitweb)
  35
  36 Inline patches (from "git format-patch" and "git send-email") to the
  37 mailing list at mailto:unxf-public@bogomips.org
  38 are preferred because they allow code review and comments in the reply to
  39 the patch.
  40
  41 We will adhere to mostly the same conventions for patch submissions as
  42 git itself.  See the Documentation/SubmittingPatches document
  43 distributed with git on on patch submission guidelines to follow.  Just
  44 don't email the git mailing list or maintainer with unxf patches.
  45
  46 == Contact
  47
  48 All feedback (bug reports, user/development discussion, patches, pull
  49 requests) go to the mailing list at mailto:unxf-public@bogomips.org
  50 No subscription is necessary to post, but HTML email is never allowed.
  51 All messages to the public-inbox are archived forever at:
  52 http://bogomips.org/unxf-public/