Skip to content

docs(selfhost): show how to generate VAPID keys on a Docker install - #344

Open
HearthCore wants to merge 1 commit into
Maneek21:masterfrom
HearthCore:docs/vapid-key-generation
Open

HearthCore wants to merge 1 commit into
Maneek21:masterfrom
HearthCore:docs/vapid-key-generation

Conversation

@HearthCore

Copy link
Copy Markdown

Summary

The only documented way to create VAPID keys is pnpm --filter @deft/api exec web-push generate-vapid-keys, which needs a source checkout with pnpm. Docker operators have neither on the host, but web-push already ships in the app image. This adds the docker compose exec variant to .env.example, states the mailto:/https:// subject rule that selfhost:doctor enforces, and lists the three VAPID variables in the self-hosting environment table.

Type

  • Docs only

Test plan

  • git diff --check is clean.
  • On a running preview.15 app container, /app/apps/api/node_modules/.bin/web-push is present and web-push exports generateVAPIDKeys. Keys generated in the container pass selfhost:doctor ([OK] Browser notifications).

Related issues

None found (searched open and closed issues and PRs).

The only documented command, pnpm --filter @deft/api exec web-push
generate-vapid-keys, needs a source checkout with pnpm. Docker operators
have neither on the host; web-push already ships in the app image.
Also list the VAPID variables in the self-hosting environment table.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant