From fd0e6d5f3c29b138ebb9f3441c3dc5fc703faeb7 Mon Sep 17 00:00:00 2001 From: David Buchmann Date: Thu, 11 Jul 2024 08:30:14 +0200 Subject: [PATCH 1/3] clarify mercure URLs --- docs/mercure.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/mercure.md b/docs/mercure.md index e63577fd25..a89b1ab8a4 100644 --- a/docs/mercure.md +++ b/docs/mercure.md @@ -8,5 +8,6 @@ No JS library or SDK required! ![Mercure](mercure-hub.png) To enable the Mercure hub, update the `Caddyfile` as described [on Mercure's site](https://mercure.rocks/docs/hub/config). +The URL to send data is `http://php/.well-known/mercure`, the public URL for clients is at the path `/.well-known/mercure`. 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). From 70ce5168da108c518398876bfa393beaade3af43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Dunglas?= Date: Fri, 12 Jul 2024 10:56:14 +0200 Subject: [PATCH 2/3] Update docs/mercure.md Co-authored-by: David Buchmann --- docs/mercure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mercure.md b/docs/mercure.md index a89b1ab8a4..97d611a9a0 100644 --- a/docs/mercure.md +++ b/docs/mercure.md @@ -8,6 +8,6 @@ No JS library or SDK required! ![Mercure](mercure-hub.png) To enable the Mercure hub, update the `Caddyfile` as described [on Mercure's site](https://mercure.rocks/docs/hub/config). -The URL to send data is `http://php/.well-known/mercure`, the public URL for clients is at the path `/.well-known/mercure`. +The path to send data as well as the path of the public URL for clients is `/.well-known/mercure`. When running FrankenPHP inside Docker, the full send URL would look like `http://php//.well-known/mercure` (with `php` being the name of the container running FrankenPHP). 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). From 93d21df8f306ea84fe45aaf2f1864fd9c7183134 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Dunglas?= Date: Fri, 12 Jul 2024 10:59:10 +0200 Subject: [PATCH 3/3] Update mercure.md --- docs/mercure.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/mercure.md b/docs/mercure.md index 97d611a9a0..223a6c8ea9 100644 --- a/docs/mercure.md +++ b/docs/mercure.md @@ -1,13 +1,15 @@ # Real-time FrankenPHP comes with a built-in [Mercure](https://mercure.rocks) hub! -Mercure allows to push events in real-time to all the connected devices: they will receive a JavaScript event instantly. +Mercure allows you to push real-time events to all the connected devices: they will receive a JavaScript event instantly. -No JS library or SDK required! +No JS library or SDK is required! ![Mercure](mercure-hub.png) To enable the Mercure hub, update the `Caddyfile` as described [on Mercure's site](https://mercure.rocks/docs/hub/config). -The path to send data as well as the path of the public URL for clients is `/.well-known/mercure`. When running FrankenPHP inside Docker, the full send URL would look like `http://php//.well-known/mercure` (with `php` being the name of the container running FrankenPHP). -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). +The path of the Mercure hub is `/.well-known/mercure`. +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). + +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).