docs: update signing key rotation guidance#1401
Open
charIeszhao wants to merge 2 commits intomasterfrom
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Logto signing key rotation documentation to reflect staged OIDC private key rotation (Next/Current/Previous), including grace-period behavior for Cloud and configuration options for OSS.
Changes:
- Document staged OIDC private key rotation with
Next/Current/Previousstatuses and lifecycle. - Add OSS grace-period configuration via
PRIVATE_KEY_ROTATION_GRACE_PERIODand CLI--gracePeriod. - Add
PRIVATE_KEY_ROTATION_GRACE_PERIODto the core service configuration reference.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/logto-oss/using-cli/rotate-signing-keys.mdx | Updates OSS CLI rotation guidance to include staged rotation/grace period and key retention model. |
| docs/developers/signing-keys.mdx | Updates Console UI rotation behavior/status model and documents Cloud/OSS grace period behavior. |
| docs/concepts/core-service/configuration.md | Adds PRIVATE_KEY_ROTATION_GRACE_PERIOD to environment variable reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying logto-docs with
|
| Latest commit: |
3fdae9b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6a4eabcf.logto-docs.pages.dev |
| Branch Preview URL: | https://charles-update-signing-key-r.logto-docs.pages.dev |
Deploying logto-docs-tutorials with
|
| Latest commit: |
3fdae9b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9e295ebb.logto-docs-tutorials.pages.dev |
| Branch Preview URL: | https://charles-update-signing-key-r.logto-docs-tutorials.pages.dev |
wangsijie
reviewed
Apr 29, 2026
Contributor
wangsijie
left a comment
wangsijie
left a comment
There was a problem hiding this comment.
🤖 PR Review
Updates the English signing-key rotation docs to describe staged OIDC private key rotation for Cloud and OSS, including grace-period configuration and key lifecycle states.
- 🔒 Security: clean
- 🏗️ Architecture: 0 high, 1 medium
- 👨💻 Engineering: 0 high, 2 medium
Verdict:
wangsijie
approved these changes
Apr 29, 2026
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
Update the English signing key rotation docs to match the new staged OIDC private key rotation behavior. This adds the Next / Current / Previous status model, documents the Cloud 4-hour grace period, explains OSS grace period configuration via PRIVATE_KEY_ROTATION_GRACE_PERIOD and CLI --gracePeriod, and adds the new environment variable to the core configuration reference.
Testing
Tested locally
Checklist
.changeset