Loading docs/manual/federation.md +15 −3 Original line number Diff line number Diff line Loading @@ -127,9 +127,21 @@ section](./context.md#getting-an-authenticated-documentloader) for details. ### `treatHttps` Whether to treat HTTP requests as HTTPS. This is useful for testing and local development. However, it must be disabled in production. Turned off by default. Whether to treat HTTP requests as HTTPS. This affects how URLs are generated as well. According to the [*Object Identifiers* section][1] in the ActivityPub specification, the public dereferenceable URIs should use HTTPS URIs, so this option is useful for testing and local development, which is normally done over HTTP. However, it should be disabled in production. Turned off by default. > [!TIP] > This option is usually used together with tunneling services like [ngrok] > in testing and local development. See also the [*Exposing a local server > to the public* section](./test.md#exposing-a-local-server-to-the-public). [1]: https://www.w3.org/TR/activitypub/#obj-id [ngrok]: https://ngrok.com/ Integrating with web frameworks Loading docs/manual/test.md +26 −1 Original line number Diff line number Diff line Loading @@ -27,13 +27,38 @@ that help you do that: - [ngrok](https://ngrok.com/) - [serveo](https://serveo.net/) - [localhost.run](https://localhost.run/) - [Tailscale Funnel](https://tailscale.com/kb/1223/funnel) > [!NOTE] > These tools are not for production use; they are for testing only. > In production, you should expose your server with a proper domain and TLS > certificate. <!-- cSpell: ignore serveo --> > [!TIP] > These tools behave like a reverse proxy, so basically the federation server > cannot recognize if it is behind a reverse proxy, and if the reverse proxy > is in HTTPS. So the federation server will generate HTTP URLs in the > ActivityPub messages, which cause interoperability issues.[^1] In this case, > you can use the [`treatHttps` option](./federation.md#treathttps) in > the `new Federation()` constructor to force the federation server to generate > HTTPS URLs: > > ~~~~ typescript > import { Federation } from "@fedify/fedify"; > > const federation = new Federation({ > // ... > treatHttps: true, // [!code highlight] > }); > ~~~~ [^1]: According to the [*Object Identifiers* section][1] in the ActivityPub specification, the public dereferenceable URIs should use HTTPS URIs. [1]: https://www.w3.org/TR/activitypub/#obj-id <!-- cSpell: ignore serveo tailscale --> Inspecting ActivityPub messages Loading Loading
docs/manual/federation.md +15 −3 Original line number Diff line number Diff line Loading @@ -127,9 +127,21 @@ section](./context.md#getting-an-authenticated-documentloader) for details. ### `treatHttps` Whether to treat HTTP requests as HTTPS. This is useful for testing and local development. However, it must be disabled in production. Turned off by default. Whether to treat HTTP requests as HTTPS. This affects how URLs are generated as well. According to the [*Object Identifiers* section][1] in the ActivityPub specification, the public dereferenceable URIs should use HTTPS URIs, so this option is useful for testing and local development, which is normally done over HTTP. However, it should be disabled in production. Turned off by default. > [!TIP] > This option is usually used together with tunneling services like [ngrok] > in testing and local development. See also the [*Exposing a local server > to the public* section](./test.md#exposing-a-local-server-to-the-public). [1]: https://www.w3.org/TR/activitypub/#obj-id [ngrok]: https://ngrok.com/ Integrating with web frameworks Loading
docs/manual/test.md +26 −1 Original line number Diff line number Diff line Loading @@ -27,13 +27,38 @@ that help you do that: - [ngrok](https://ngrok.com/) - [serveo](https://serveo.net/) - [localhost.run](https://localhost.run/) - [Tailscale Funnel](https://tailscale.com/kb/1223/funnel) > [!NOTE] > These tools are not for production use; they are for testing only. > In production, you should expose your server with a proper domain and TLS > certificate. <!-- cSpell: ignore serveo --> > [!TIP] > These tools behave like a reverse proxy, so basically the federation server > cannot recognize if it is behind a reverse proxy, and if the reverse proxy > is in HTTPS. So the federation server will generate HTTP URLs in the > ActivityPub messages, which cause interoperability issues.[^1] In this case, > you can use the [`treatHttps` option](./federation.md#treathttps) in > the `new Federation()` constructor to force the federation server to generate > HTTPS URLs: > > ~~~~ typescript > import { Federation } from "@fedify/fedify"; > > const federation = new Federation({ > // ... > treatHttps: true, // [!code highlight] > }); > ~~~~ [^1]: According to the [*Object Identifiers* section][1] in the ActivityPub specification, the public dereferenceable URIs should use HTTPS URIs. [1]: https://www.w3.org/TR/activitypub/#obj-id <!-- cSpell: ignore serveo tailscale --> Inspecting ActivityPub messages Loading
