Headers

These are special Moera HTTP headers. Read more about them in the Architecture Overview section.

Clients

X-Moera: [root={root}] [page={page}]

This header is sent by a website in HTTP response. It signals that the website supports Moera REST API and the current page corresponds to the Moera virtual page {page}. If page is not set, the current page itself is considered to be a virtual page.

If root is set, it points to the Moera root of the website (matches the website root by default). Virtual pages are located under /moera subdirectory of the Moera root, the REST API endpoint is located at /moera/api.

X-Moera: redirect={url} [connectedOnly={true or false}]

This header is sent by a standalone web client in HTTP response. If the browser extension detects it, it immediately performs HTTP redirect to the <url> specified in the redirect parameter. If connectedOnly parameter is set to true and the browser extension has no connection data yet, the redirect is delayed until the web client starts and transfers its connection data to the browser extension.

This mechanism allows users that have the browser extension installed to seamlessly move from a standalone web client to the browser extension-based client.

X-Accept-Moera: {version}

This header is sent by the client in HTTP request. It signals that the client supports Moera REST API of the given version. Currently only version 1.0 is defined.

Plugins

X-Moera-Auth: [root-admin={true or false}] [admin={true or false}] [auth-category={comma-separated list}] [client-name={name}] [remote-address={IP address}] [user-agent={browser name}] [user-agent-os={OS name}] [node-id={ID}] [node-name={node name}] [domain-name={domain name}]

This header is sent by the node to a plugin when forwarding a user request to it. All fields have the same meaning as corresponding fields of PluginContext structure.

X-Moera-Origin: {url}

This header is sent by the node to a plugin when forwarding a user request to it. It contains the full URL of the user request.