Skip to content

Commit

Permalink
docs: fix: UI endpoint + add in into directives detail (#457)
Browse files Browse the repository at this point in the history
  • Loading branch information
silverbackdan committed Jan 23, 2021
1 parent 5954826 commit d1dfafb
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/hub/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ When using environment variables, list must be space separated. As flags paramet
| `compress` | Use HTTP compression | `false` |
| `cors_allowed_origins` | a space-separated list of allowed CORS origins, can be `*` for all | |
| `debug` | debug mode, **dangerous, don't enable in production** (logs updates' content, why an update is not send to a specific subscriber and recovery stack traces) | `false` |
| `demo` | demo mode (automatically enabled when `debug` is `true`) | `false` |
| `demo` | demo mode (automatically enabled when `debug` is `true`) and enables ui at `https://example.com/.well-known/mercure/ui/` | `false` |
| `dispatch_timeout` | maximum duration of the dispatch of a single update, set to `0s` to disable | `5s` |
| `subscriptions` | expose the subscription web API and dispatch private updates when a subscription between the Hub and a subscriber is established or closed. The topic follows the template `/.well-known/mercure/subscriptions/{topicSelector}/{subscriberID}` | `false` |
| `heartbeat_interval` | interval between heartbeats (useful with some proxies, and old browsers), set to `0s` to disable | `40s` |
Expand Down
2 changes: 1 addition & 1 deletion docs/hub/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ When the server is up and running, the following endpoints are available:
* `POST https://example.com/.well-known/mercure`: to publish updates
* `GET https://example.com/.well-known/mercure`: to subscribe to updates

In demo mode, an UI is also available: `https://example.com/.well-known/mercure/ui`.
In demo mode, an UI is also available: `https://example.com/.well-known/mercure/ui/`.

See [the protocol](../../spec/mercure.md) for more details about these endpoints.

Expand Down

0 comments on commit d1dfafb

Please sign in to comment.