Unverified Commit 0c3965be authored by Hong Minhee's avatar Hong Minhee
Browse files

More docs about 0f44ca2e

[ci skip]
parent 562e3dc0
Loading
Loading
Loading
Loading
(256 KiB)

File changed.

No diff preview for this file type.

+30 −2
Original line number Diff line number Diff line
@@ -587,8 +587,8 @@ unexpected URLs when a request bypasses a reverse proxy or a load balancer.
> [!TIP]
> If your federated server needs to support [multiple domains on the same
> server](#virtual-hosting), you would not want to set the canonical origin
> explicitly.  Instead, you should rely on the `Host` header or
> `X-Forwarded-Host` header to determine the domain name.
> explicitly.  Instead, you should rely on the [`Host`] header or
> [`X-Forwarded-Host`] header to determine the domain name.


Separating WebFinger host from the server origin
@@ -621,6 +621,31 @@ const federation = createFederation({
});
~~~~

That is not all.  You also need to make the */.well-known/webfinger* endpoint
of the `~FederationOrigin.handleHost` to redirect to the
*/.well-known/webfinger* endpoint of the `~FederationOrigin.webOrigin` unless
you want to connect the `~FederationOrigin.handleHost` to the same server as
the `~FederationOrigin.webOrigin`.  For example, if your
`~FederationOrigin.handleHost` is served by [Caddy], you can use the following
configuration to redirect the WebFinger requests:

~~~~ caddy
example.com {
  redir /.well-known/webfinger https://ap.example.com/.well-known/webfinger
}
~~~~

Or if you use [nginx], you can use the following configuration:

~~~~ nginx
server {
  server_name example.com;
  location /.well-known/webfinger {
    return 301 https://ap.example.com$request_uri;
  }
}
~~~~

> [!NOTE]
> Even if you set the `~FederationOrigin.handleHost` different from the
> `~FederationOrigin.webOrigin`, the other fediverse handle with the same
@@ -631,6 +656,9 @@ const federation = createFederation({
>  -  `@alice@example.com`
>  -  `@alice@ap.example.com`

[Caddy]: https://caddyserver.com/
[nginx]: https://nginx.org/


Integrating with web frameworks
-------------------------------
+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@
    "@braintree/sanitize-url": "^7.1.1",
    "@deno/kv": "^0.8.4",
    "@fedify/amqp": "0.1.0",
    "@fedify/fedify": "1.5.0-dev.679",
    "@fedify/fedify": "1.5.0-dev.680",
    "@fedify/postgres": "0.2.2",
    "@fedify/redis": "0.3.0",
    "@hono/node-server": "^1.13.7",