Skip to content

docs: describe sign-in, access and file serving as they are now - #48

Merged
johnf merged 1 commit into
mainfrom
docs/readme-how-it-fits
Nov 4, 2026
Merged

johnf merged 1 commit into
mainfrom
docs/readme-how-it-fits

Conversation

@johnf

@johnf johnf commented Nov 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

The README's "How it fits together" section pointed to files that no longer exist, and described file downloads as signed URLs.

- Access control: … (src/auth.ts, src/routes/auth.ts)
- File downloads: short-lived signed URLs … (src/routes/file.ts)
+ Sign-in: the API is its own OIDC provider … (src/oidc/)
+ Access control: every entity is visible, access is by licence via REMS (src/auth.ts)
+ Files and metadata: arocapi's OCFL storage backend serves files; metadata comes from the structural index (src/app.ts)

The arocapi link now points to crate-works/arocapi.

Evidence

  • Before: ls src/routes/auth.ts src/routes/file.ts → No such file or directory
    After: every path the section names (src/oidc/, src/auth.ts, src/app.ts) exists

Merge Danger

Door: two-way

Blast Radius: none (docs only)

@johnf
johnf merged commit e759e90 into main Nov 4, 2026
5 checks passed
@johnf
johnf deleted the docs/readme-how-it-fits branch November 4, 2026 00:54
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