docs: document --dapc seed flag for air-gapped OSS installs#1417
Open
darcyYe wants to merge 2 commits into
Open
docs: document --dapc seed flag for air-gapped OSS installs#1417darcyYe wants to merge 2 commits into
darcyYe wants to merge 2 commits into
Conversation
4 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Logto OSS documentation to explain the new db seed --dapc / --disable-admin-pwned-password-check flag in @logto/cli, aimed at unblocking first-admin sign-up in air-gapped/offline environments where api.pwnedpasswords.com is unreachable.
Changes:
- Adds a new “Seed for air-gapped or offline deployments” section to the Logto CLI docs, including usage examples and scope notes (admin tenant only).
- Adds a cross-referenced tip under “Database setup” in deployment docs to help operators discover the flag during installation planning.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/logto-oss/using-cli/README.mdx | Documents --dapc behavior, scope, and provides CLI/npm/npx examples with a stable anchor for cross-linking. |
| docs/logto-oss/deployment-and-configuration.mdx | Adds an “Air-gapped or offline installs” tip that points readers to the detailed CLI documentation section. |
Comments suppressed due to low confidence (1)
docs/logto-oss/using-cli/README.mdx:91
- The service name is typically written as “Have I Been Pwned” (HIBP). Consider updating the link text to match the official name for clarity and consistency.
When set, the seeded `sign_in_experiences.password_policy` row for the **admin tenant** is `{"rejects": {"pwned": false}}` instead of the default `{}`. This skips the [HaveIBeenPwned (HIBP)](https://haveibeenpwned.com/) password breach check during the first admin sign-up, so creating the initial admin from the Welcome page no longer hangs when `api.pwnedpasswords.com` is unreachable (for example in air-gapped data centers or behind strict egress firewalls).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --dapc, --disable-admin-pwned-password-check | ||
| ``` | ||
|
|
||
| When set, the seeded `sign_in_experiences.password_policy` row for the **admin tenant** is `{"rejects": {"pwned": false}}` instead of the default `{}`. This skips the [HaveIBeenPwned (HIBP)](https://haveibeenpwned.com/) password breach check during the first admin sign-up, so creating the initial admin from the Welcome page no longer hangs when `api.pwnedpasswords.com` is unreachable (for example in air-gapped data centers or behind strict egress firewalls). |
|
|
||
| :::tip Air-gapped or offline installs | ||
|
|
||
| If your deployment environment cannot reach `api.pwnedpasswords.com`, append `--dapc` to the seed command so the first admin sign-up does not hang on the HaveIBeenPwned breach check. See [Seed for air-gapped or offline deployments](/logto-oss/using-cli#seed-for-air-gapped-or-offline-deployments) for details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
db seed --disable-admin-pwned-password-check(alias--dapc) flag added to@logto/cliin logto-io/logto#8859. The flag pre-disables the Have I Been Pwned (HIBP) breach check on the admin tenant, unblocking first-admin sign-up for OSS deployments that cannot reachapi.pwnedpasswords.com(air-gapped data centers, strict egress firewalls).Files updated:
docs/logto-oss/using-cli/README.mdx— new section "Seed for air-gapped or offline deployments" describing the flag, its scope (admin tenant only), and how to re-enable HIBP later from the Admin Console > Sign-in experience > Password policy.docs/logto-oss/deployment-and-configuration.mdx— short admonition under "Database setup" cross-referencing the new CLI section so air-gapped operators see the flag while planning their Postgres setup.Only English docs are updated. Translated copies under
i18n/are left to the regular translation pipeline.Testing
Tested locally
Checklist
.changeset(only when explicitly required)