Skip to content

Commit 75ce2e2

Browse files
dbudunglas
andauthored
docs: clarify Mercure URLs (#916)
* clarify mercure URLs * Update docs/mercure.md Co-authored-by: David Buchmann <david@liip.ch> * Update mercure.md --------- Co-authored-by: Kévin Dunglas <kevin@dunglas.fr>
1 parent 5a43e9f commit 75ce2e2

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

docs/mercure.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Real-time
22

33
FrankenPHP comes with a built-in [Mercure](https://mercure.rocks) hub!
4-
Mercure allows to push events in real-time to all the connected devices: they will receive a JavaScript event instantly.
4+
Mercure allows you to push real-time events to all the connected devices: they will receive a JavaScript event instantly.
55

6-
No JS library or SDK required!
6+
No JS library or SDK is required!
77

88
![Mercure](mercure-hub.png)
99

1010
To enable the Mercure hub, update the `Caddyfile` as described [on Mercure's site](https://mercure.rocks/docs/hub/config).
1111

12-
To push Mercure updates from your code, we recommend the [Symfony Mercure Component](https://symfony.com/components/Mercure) (you don't need the Symfony full stack framework to use it).
12+
The path of the Mercure hub is `/.well-known/mercure`.
13+
When running FrankenPHP inside Docker, the full send URL would look like `http://php/.well-known/mercure` (with `php` being the container's name running FrankenPHP).
14+
15+
To push Mercure updates from your code, we recommend the [Symfony Mercure Component](https://symfony.com/components/Mercure) (you don't need the Symfony full-stack framework to use it).

0 commit comments

Comments
 (0)