Skip to content

docs(auth): document passkey deployment - #348

Open
alexj11324 wants to merge 1 commit into
OpenListTeam:mainfrom
alexj11324:codex/passkey-auth-docs
Open

docs(auth): document passkey deployment#348
alexj11324 wants to merge 1 commit into
OpenListTeam:mainfrom
alexj11324:codex/passkey-auth-docs

Conversation

@alexj11324

Copy link
Copy Markdown

Description / 描述

Add a bilingual passkey guide covering:

  • administrator enablement and user credential management;
  • compatibility with existing WebAuthn credentials;
  • canonical HTTPS site_url, exact origin/RP validation, and reverse-proxy requirements;
  • the five-minute in-memory challenge store and single-process deployment constraint.

Motivation and Context / 背景

The coordinated passkey implementation has security-sensitive deployment requirements that must be visible to operators before enabling the feature.

Relates to OpenListTeam/OpenList#2849
Relates to OpenListTeam/OpenList-Frontend#610

Checklist / 检查清单

  • I have read the CONTRIBUTING document.
    我已阅读 CONTRIBUTING 文档。
  • I have formatted my code or documentation with prettier or other appropriate formatter.
    我已使用 prettier 或其他适当的格式化工具格式化提交的代码或文档。
  • I have updated all supported languages (including Chinese and English) for documentation. (If it's needed)
    我已为所有支持语言(包括中文和英文)更新文档内容。 (若适用)
  • I have verified that the written documentation or code is properly formatted, with no syntax errors, spelling mistakes.
    我已确认编写的文档或代码格式正确, 无语法错误, 拼写错误。
  • I have updated the repository accordingly (If it's needed).
    我已相应更新了相关仓库(若适用)。

Testing

  • pnpm exec prettier --check pages/guide/advanced/passkeys.md
  • pnpm build

AI assistance disclosure

Codex assisted with implementation and validation; the contributor reviewed the resulting documentation and evidence before submission.

- Explain enablement, credential compatibility, and management behavior.\n- Document exact HTTPS origin and single-process challenge-store requirements.\n\nCo-authored-by: Codex <267193182+codex@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 26, 2026 15:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.


::: en

An administrator must enable the global `webauthn_login_enabled` setting before users

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The front-end display name should be used instead of the code name.

应使用前端显示名称而非代码名称。

the setting makes them available again.

Credentials created by earlier OpenList versions remain valid. They appear with a
generated name and unknown creation metadata until renamed; `last_used_at` is populated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

同上

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.

3 participants