936aa50f9a
Eliminate all code, tests, and utilities related to the legacy 'unclaimed' user scope. All API endpoints, document and audiobook storage, and access logic now require a valid authenticated userId and only operate on resources owned by that user. Remove related helper functions, test cases, and conditional flows for anonymous/unclaimed data. Update types, client APIs, and UI logic to reflect that only 'user' scope is supported. This simplifies ownership checks and removes ambiguity around document and audiobook access.
64 lines
2.8 KiB
Markdown
64 lines
2.8 KiB
Markdown
---
|
|
title: Auth
|
|
---
|
|
|
|
This page covers application-level configuration for provider access and authentication.
|
|
|
|
## Auth behavior
|
|
|
|
- `BASE_URL` and `AUTH_SECRET` are required at startup in v4+.
|
|
- Keep `AUTH_TRUSTED_ORIGINS` empty to trust only `BASE_URL`.
|
|
- Anonymous auth sessions are disabled by default.
|
|
- Set `USE_ANONYMOUS_AUTH_SESSIONS=true` to enable anonymous session flows.
|
|
|
|
## Runtime modes
|
|
|
|
OpenReader has two common runtime modes:
|
|
|
|
- **Auth enabled, non-admin user**: user account/session features are available, but no admin controls.
|
|
- **Auth enabled, admin user**: full **Settings → Admin** access (shared providers + site features).
|
|
|
|
## Admin role
|
|
|
|
You can designate one or more users as admins via the `ADMIN_EMAILS` env var:
|
|
|
|
```env
|
|
ADMIN_EMAILS=alice@example.com,bob@example.com
|
|
```
|
|
|
|
Admins see a new **Admin** tab in **Settings** with two sub-tabs:
|
|
|
|
- **Shared TTS providers** — server-managed TTS provider instances with encrypted keys, visible to all users.
|
|
- **Site features** — runtime overrides for what were previously build-time public env flags (including account signup availability, default TTS provider, audiobook export, etc.).
|
|
|
|
Admin assignment is reconciled on every session resolution, so removing an email from `ADMIN_EMAILS` demotes the user on next login without a restart. See [Admin Panel](./admin-panel) for the full reference.
|
|
|
|
## Route behavior
|
|
|
|
- `/` is a public landing/onboarding page and remains indexable.
|
|
- `/app` is the protected app home (document list and uploader UI).
|
|
- If a valid session exists (including anonymous), visiting `/` redirects to `/app`.
|
|
- Protected app routes continue to require auth; when anonymous sessions are disabled and no session exists, users are redirected to `/signin`.
|
|
|
|
## Related docs
|
|
|
|
- For auth environment variables: [Environment Variables](../reference/environment-variables#auth-and-identity)
|
|
- For admin role and shared TTS provider config: [Admin Panel](./admin-panel)
|
|
- For TTS character limits and quota behavior: [TTS Rate Limiting](./tts-rate-limiting)
|
|
- For provider-specific guidance: [TTS Providers](./tts-providers)
|
|
- For storage/S3/SeaweedFS behavior: [Object / Blob Storage](./object-blob-storage)
|
|
- For database mode: [Database](./database)
|
|
- For migration behavior and commands: [Migrations](./migrations)
|
|
|
|
## Sync notes
|
|
|
|
### Auth enabled
|
|
|
|
- Settings and reading progress are saved to the server.
|
|
- Updates are not instant push-based sync; they use normal client polling/refresh behavior.
|
|
- If two devices change the same item around the same time, the newest update wins.
|
|
|
|
## Claim modal note
|
|
|
|
- You may still see old anonymous settings/progress available to claim from older deployments.
|
|
- Legacy `unclaimed` data is only surfaced through the claim flow; normal authenticated routes are scoped to your current user id.
|