racket / racket/web-server

Docs shouldn't recommend `mod_rewrite` for Apache

Open
#127 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Racket
Stars
99
Forks
48
PR merge metrics
No merged PRs in 30d

Description

The documentation on using Apache with the Racket Web Server currently recommends mod_rewrite:

https://github.com/racket/web-server/blob/e321f8425e539d22412d4f7763532b3f3a65c95e/web-server-doc/web-server/scribblings/server-faq.scrbl#L7-L29

However, the extended documentation for mod_rewrite lists Simple Proxying as an example of when not to use mod_rewrite: it recommends ProxyPass from mod_proxy.

I was reminded of this while writing https://github.com/racket/web-server/issues/126#issuecomment-1635890589. I'm not sure if I have a working example to contribute at the moment (I'm in the midst of some configuration changes locally), but I'll send one if I do.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with web-server-doc/web-server/scribblings/server-faq.scrbl at the referenced lines, then review Apache's guidance on avoiding mod_rewrite for simple proxying and its mod_proxy ProxyPass documentation. Done means the FAQ no longer recommends mod_rewrite for this setup and provides an accurate alternative or working example if one is available.

Written by the indexing model from the issue text.

Assessment

Tech stack
apache
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.