Install the Mercure.rocks hub
Managed and HA Versions
Managed and High Availability versions of Mercure.rocks are available, give them a try!
The Mercure.rocks hub is available as a custom build of the Caddy web server including the Mercure.rocks module.
First, download the archive corresponding to your operating system and architecture from the release page, extract the archive and open a shell in the resulting directory.
Note: Mac OS users must use the
Then, on Linux and Mac OS X, run:
On Windows, start PowerShell, go into the extracted directory and run:
The Windows Defender Firewall will ask you if you want to allow
mercure.exe to communicate through it.
Allow it for both public and private networks. If you use an antivirus, or another firewall software, be sure to whitelist
The server is now available on
https://localhost, with the demo mode enabled. Because the
allow_anonymous directive is set in the provided configuration, anonymous subscribers are allowed.
To run the server in production, see how to configure the Mercure.rocks hub.
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:
See the protocol for more details about these endpoints.
To compile the development version, see https://github.com/dunglas/mercure/blob/master/CONTRIBUTING.md.
Custom Caddy Build
xcaddy build --with github.com/dunglas/mercure
A Docker image is available on Docker Hub. The following command is enough to get a working server in demo mode:
docker run -p 80:80 -p 443:443 dunglas/mercure
The server, in demo mode, is available on
https://localhost. Anonymous subscribers are allowed.
Mercure.rocks is available on the AUR, you can install it with your favorite AUR wrapper:
yay -S mercure
Or download the
PKGBUILD and compile and install it: