nikdoof/pocket-id
1
0
Fork 0
mirror of https://github.com/nikdoof/pocket-id.git synced 2025-12-14 07:12:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve text in README

Browse Source
This commit is contained in:
Elias Schneider
2024-12-20 08:20:40 +01:00
parent daced661c4
commit ff75322e7d
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -17,7 +17,7 @@ Additionally, what makes Pocket ID special is that it only supports [passkey](ht
### Before you start ### 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) ### Installation with Docker (recommended)
@@ -78,14 +78,14 @@ Required tools:
# Optional: Start Caddy (You can use any other reverse proxy) # Optional: Start Caddy (You can use any other reverse proxy)
cd .. 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`. You can now sign in with the admin account on `http://localhost/login/setup`.
### Nginx Reverse Proxy ### 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 ```nginx
proxy_busy_buffers_size 512k; proxy_busy_buffers_size 512k;
@@ -95,7 +95,7 @@ proxy_buffer_size 256k;
## Proxy Services with Pocket ID ## 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. 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) # Optional: Start Caddy (You can use any other reverse proxy)
cd .. 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 ## Environment variables