From ff75322e7de08970d8573cd3f081194305b0daee Mon Sep 17 00:00:00 2001 From: Elias Schneider Date: Fri, 20 Dec 2024 08:20:40 +0100 Subject: [PATCH] docs: improve text in README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e317f9b..fd4f7fe 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Additionally, what makes Pocket ID special is that it only supports [passkey](ht ### Before you start -Pocket ID requires a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), meaning it must be served over HTTPS. This is necessary because Pocket ID uses the [WebAuthn API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API) which requires a secure context. +Pocket ID requires a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), meaning it must be served over HTTPS. This is necessary because Pocket ID uses the [WebAuthn API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API). ### Installation with Docker (recommended) @@ -78,14 +78,14 @@ Required tools: # Optional: Start Caddy (You can use any other reverse proxy) cd .. - pm2 start --name pocket-id-caddy caddy -- run --config Caddyfile + pm2 start --name pocket-id-caddy caddy -- run --config reverse-proxy/Caddyfile ``` You can now sign in with the admin account on `http://localhost/login/setup`. ### Nginx Reverse Proxy -To use Nginx in front of Pocket ID, add the following configuration to increase the header buffer size because, as SvelteKit generates larger headers. +To use Nginx as a reverse proxy for Pocket ID, update the configuration to increase the header buffer size. This adjustment is necessary because SvelteKit generates larger headers, which may exceed the default buffer limits. ```nginx proxy_busy_buffers_size 512k; @@ -95,7 +95,7 @@ proxy_buffer_size 256k; ## Proxy Services with Pocket ID -As the goal of Pocket ID is to stay simple, we don't have a built-in proxy provider. However, you can use [OAuth2 Proxy](https://oauth2-proxy.github.io/oauth2-proxy) to add authentication to your services that don't support OIDC. +As the goal of Pocket ID is to stay simple, it doesn't have a built-in proxy provider. However, you can use [OAuth2 Proxy](https://oauth2-proxy.github.io/oauth2-proxy) to add authentication to your services that don't support OIDC. See the [guide](docs/proxy-services.md) for more information. @@ -136,7 +136,7 @@ docker compose up -d # Optional: Start Caddy (You can use any other reverse proxy) cd .. - pm2 start caddy --name pocket-id-caddy -- run --config Caddyfile + pm2 start caddy --name pocket-id-caddy -- run --config reverse-proxy/Caddyfile ``` ## Environment variables