[darksworm]

Adds a Front proxy section to the README. doormouse only wakes machines and puts them to sleep. TLS, auth, rate limits, compression and caching belong to a reverse proxy in front of it.

This is the README section promised when closing #37 and #2.

What's in it

• The recommended setup: client -> front proxy -> doormouse -> machine.
• Two front-proxy settings that matter: pass the Host header through, and wait longer than doormouse's timeout (nginx gives up after 60s by default).
• An nginx example that caches static paths, with a table of what happens when an entry is fresh, stale or missing.
• A note that nginx's inactive defaults to 10 minutes and deletes unused entries even when they are fresh.
• The quick-start note about front proxies now links to the new section.

Testing

I ran the nginx setup locally: nginx 1.27.5 in front of doormouse, in front of a fake machine that wakes when it gets a magic packet.

Situation	Result
Machine asleep, nothing cached	Went through doormouse, machine woke, about 1s
Machine asleep, fresh entry	Served by nginx, no magic packet, machine stayed asleep
Machine asleep, stale entry	Served by nginx at once; the background refresh woke the machine
After that refresh	Fresh cache hit again

The README's nginx config passes nginx -t. The new section scores Flesch-Kincaid grade 5.4. Varnish is mentioned as working the same way but was not tested.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added guidance for running doormouse behind a front proxy, including header forwarding and timeout settings.
  • Added an nginx example for caching /assets/, with details on cache freshness, inactive entries, authenticated requests, cookies, and stale responses.

[coderabbitai]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: 975e0216-3eca-4b61-9a1c-7302682f7763

📥 Commits

Reviewing files that changed from the base of the PR and between 884ab50 and d5476c5.

📒 Files selected for processing: 1

• README.md

+--------------------------------------------------------------------------------+
| A bunny is never late, nor is he early, he reviews precisely when he means to. |
+--------------------------------------------------------------------------------+
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}