Skip to content

Commit c6442c4

Browse files
committed
[mercure] Update docs for v0.11
1 parent c8a0a72 commit c6442c4

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

mercure.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,17 @@ clients.
6868
An official and open source (AGPL) implementation of a Hub can be downloaded
6969
as a static binary from `Mercure.rocks`_.
7070

71-
Run the following command to start it:
71+
On Linux and Mac, run the following command to start it:
7272

7373
.. code-block:: terminal
7474
75-
$ ./mercure --jwt-key='!ChangeMe!' --addr='localhost:3000' --allow-anonymous --cors-allowed-origins='*'
75+
SERVER_NAME=:3000 MERCURE_PUBLISHER_JWT_KEY="!ChangeMe!" MERCURE_SUBSCRIBER_JWT_KEY="!ChangeMe!" ./mercure run -config Caddyfile.dev
76+
77+
On Windows run:
78+
79+
.. code-block:: terminal
80+
81+
$envSERVER_NAME=':3000'; $env:MERCURE_PUBLISHER_JWT_KEY='!ChangeMe!'; $env:MERCURE_SUBSCRIBER_JWT_KEY='!ChangeMe!'; .\mercure.exe run -config Caddyfile.dev
7682
7783
.. note::
7884

@@ -175,8 +181,8 @@ the **topic** being updated. This topic should be an `IRI`_
175181
of the resource being dispatched.
176182

177183
Usually, this parameter contains the original URL of the resource
178-
transmitted to the client, but it can be any valid `IRI`_, it doesn't
179-
have to be a URL that exists (similarly to XML namespaces).
184+
transmitted to the client, but it can be any string or `IRI`_,
185+
and it doesn't have to be a URL that exists (similarly to XML namespaces).
180186

181187
The second parameter of the constructor is the content of the update.
182188
It can be anything, stored in any format.

0 commit comments

Comments
 (0)