ops: write docs/operations/update-saml2-certificate.md

Open Beginner friendly
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
api, documentation, security

Research direction

Create docs/operations/update-saml2-certificate.md. Start with specs/api/saml.md#cert--key-rotation and inspect the repository for the API secrets backend and SAML settings; use PR #49 for context. Done means the runbook includes runnable openssl commands, the Slack admin UI link, secret-update steps, an API restart step, and the three-year rotation cadence.

Written by the indexing model from the issue text.

Description

SAML IdP cert rotation procedure to parallel laddr's legacy doc.

Per specs/api/saml.md, the rotation steps are:

  1. Generate new key + cert
  2. Update Slack's admin UI with the new public cert
  3. Update the API's SAML_PRIVATE_KEY / SAML_CERTIFICATE secrets
  4. Restart the API

The doc should expand these into runnable commands (openssl invocation, Slack admin UI link, our secrets backend), and include the cadence (3 years). Surfaced by the saml-idp plan's closeout (PR #49) — the runbook step isn't owned by any other planned work.

Dominant language
TypeScript
Stars
1
Forks
1
Avg merge
1d 20h
Merged PRs (30d)
25

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CodeForPhilly/codeforphilly-ng

All issues in CodeForPhilly/codeforphilly-ng

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.