Skip to content

docs(auth): document programmatic/bot auth, slim stale provider docs #588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tompscanlan merged 2 commits into from
Jun 2, 2026
Merged

docs(auth): document programmatic/bot auth, slim stale provider docs #588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07de852
docs(auth): document programmatic/bot auth and slim stale provider docs
tompscanlan May 30, 2026
1cb2f69
docs(auth): clarify service auth is PDS-generic, add PDS discovery
tompscanlan Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,15 @@ See **[DEVELOPMENT.md](./DEVELOPMENT.md)** for complete local development instru

> **Low RAM?** Use `docker-compose-slim.yml` (~675MB) instead of the full dev compose. It includes only the essentials: API, PostgreSQL, Redis, and Maildev.

### Documentation

In-depth guides live in [`docs/`](./docs/). Notably:

- **[Auth](./docs/auth.md)** — authenticating against the API, including the
refresh-token flow and **programmatic / bot access** (email + ATProto service
auth) for automation and integrations.
- Interactive API reference: [api.openmeet.net/docs](https://api.openmeet.net/docs) (Swagger/OpenAPI)

### Database Migrations

Migrations are **not** run automatically on `docker compose up`. Run them manually:
Expand Down
Loading
Loading