Skip to content

Commit a8f0495

Browse files
authored
Simplify README by removing excess information
Removed unnecessary details about webhook integration complexities and client usage instructions.
1 parent 31544ab commit a8f0495

1 file changed

Lines changed: 0 additions & 7 deletions

File tree

README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ and the response is sent back to production.
1111

1212
Webhook integrations are awkward to build locally because **the third-party needs to reach your machine**:
1313

14-
- Your FastAPI server is on `localhost`, behind NAT/firewalls, and often on an unreliable dev network.
15-
- “Just open a port” is rarely an option (corporate networks, Wi‑Fi, security policies).
16-
1714
Tools like ngrok (and similar tunneling/reverse-proxy setups) can solve this, but for webhook development they can also feel **overly complex**: extra moving parts, extra configuration, and yet another service to pay for.
1815

1916
This project is the alternative I wanted: **a simple, free, open-source relay** specifically for developing webhook handlers. Instead of exposing your laptop to the internet, updating your webhook registration, you run a tiny websocket “relay” websocket in production. Then you connect a local client, receive real webhook requests, replay them against `http://localhost:...`, and send the response back upstream.
@@ -50,10 +47,6 @@ When installed (default `path_prefix` is `/fastapi-dev-proxy`), the relay regist
5047

5148
### Client usage
5249

53-
The client must include the shared token as the `token` query param when connecting (e.g. `...?token=...`). To avoid hardcoding secrets in source control, read it from an environment variable.
54-
55-
### CLI
56-
5750
```
5851
export FASTAPI_DEV_PROXY_TOKEN="your-shared-token"
5952

0 commit comments

Comments
 (0)