Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of X-Original-URL. #94

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,22 @@ app.use('/ftp', express.static('public/ftp'), serveIndex('public/ftp', {'icons':
app.listen(3000)
```

### Use with Reverse Proxy

To use `serve-index` with a reverse proxy, first set "X-Original-URL" in your
proxy server. Then add an `originalUrl` property to the request. For example,
with express.

```javascript
app.use(function(req, res, next) {
if ('x-original-url' in req.headers) {
req.originalUrl = req.headers['x-original-url']
}

next()
})
```

## License

[MIT](LICENSE). The [Silk](http://www.famfamfam.com/lab/icons/silk/) icons
Expand Down