chore: update README, Dockerfile, compose.yml — add frontend/worker services, SSR env var, feature list
Some checks failed
lint / lint (push) Has been cancelled
test / unit (push) Has been cancelled
test / integration (push) Has been cancelled
lint / lint (pull_request) Has been cancelled
test / unit (pull_request) Has been cancelled
test / integration (pull_request) Has been cancelled
Some checks failed
lint / lint (push) Has been cancelled
test / unit (push) Has been cancelled
test / integration (push) Has been cancelled
lint / lint (pull_request) Has been cancelled
test / unit (pull_request) Has been cancelled
test / integration (pull_request) Has been cancelled
This commit is contained in:
37
README.md
37
README.md
@@ -6,8 +6,11 @@ A self-hosted microblogging server with full ActivityPub federation. Write short
|
||||
|
||||
- Short-form posts (thoughts) with replies, boosts, and likes
|
||||
- Full ActivityPub federation — follow/unfollow remote actors, accept/reject followers, federated content broadcast as `Note` objects, paginated outbox, NodeInfo discovery, WebFinger, shared inbox, actor profile sync
|
||||
- **Remote actor discovery** — search by `@user@instance` handle, view full remote profiles (bio, banner, profile fields, posts, followers, following tabs), follow from within the UI
|
||||
- **Worker-backed remote caches** — remote posts and follower/following lists are fetched by the NATS worker and cached locally; profiles populate on first visit and refresh in the background
|
||||
- Content negotiation at `GET /users/{username}` — serves ActivityPub actor JSON or REST profile based on `Accept` header
|
||||
- Federation moderation — per-instance domain blocking, per-user actor blocking with `Block` activity delivery, delivery filter excludes blocked actors and blocked-domain inboxes
|
||||
- Async event fan-out via NATS — notifications and AP delivery run in a separate worker process
|
||||
- Async event fan-out via NATS JetStream — notifications and AP delivery run in a separate worker process; pull consumer with 1-hour TTL caching
|
||||
- JWT authentication (Bearer token)
|
||||
- OpenAPI documentation at `/docs` (Swagger UI) and `/scalar` (Scalar)
|
||||
- Full-text search over thoughts and users via PostgreSQL trigram indexes
|
||||
@@ -87,18 +90,33 @@ All REST endpoints are under the root path. Authentication uses `Authorization:
|
||||
|
||||
Interactive API documentation is available at runtime:
|
||||
|
||||
- **Swagger UI** — `http://localhost:3000/docs`
|
||||
- **Scalar** — `http://localhost:3000/scalar`
|
||||
- **Swagger UI** — `http://localhost:8000/docs`
|
||||
- **Scalar** — `http://localhost:8000/scalar`
|
||||
|
||||
## Frontend
|
||||
|
||||
The Next.js frontend lives in `thoughts-frontend/`. It requires two environment variables:
|
||||
|
||||
```env
|
||||
NEXT_PUBLIC_API_URL=http://localhost:8000 # client-side requests
|
||||
NEXT_PUBLIC_SERVER_SIDE_API_URL=http://localhost:8000 # SSR requests
|
||||
```
|
||||
|
||||
```bash
|
||||
cd thoughts-frontend
|
||||
bun install
|
||||
bun run dev # http://localhost:3000
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
The image contains both `thoughts` (API server) and `thoughts-worker` (event processor). Run them as separate containers:
|
||||
The backend image contains both `thoughts` (API server) and `thoughts-worker` (event processor). Run them as separate containers:
|
||||
|
||||
```bash
|
||||
docker build -t thoughts .
|
||||
|
||||
# API server
|
||||
docker run -p 3000:3000 \
|
||||
docker run -p 8000:8000 \
|
||||
-e DATABASE_URL=postgres://postgres:password@db:5432/thoughts \
|
||||
-e JWT_SECRET=change-me \
|
||||
-e BASE_URL=https://yourdomain.example.com \
|
||||
@@ -112,8 +130,17 @@ docker run \
|
||||
-e NATS_URL=nats://nats:4222 \
|
||||
--entrypoint ./thoughts-worker \
|
||||
thoughts
|
||||
|
||||
# Frontend
|
||||
docker build -t thoughts-frontend \
|
||||
--build-arg NEXT_PUBLIC_API_URL=https://api.yourdomain.example.com \
|
||||
--build-arg NEXT_PUBLIC_SERVER_SIDE_API_URL=http://thoughts:8000 \
|
||||
thoughts-frontend/
|
||||
docker run -p 3000:3000 thoughts-frontend
|
||||
```
|
||||
|
||||
See `compose.yml` for a full local development stack.
|
||||
|
||||
## License
|
||||
|
||||
MIT License. See [LICENSE](LICENSE).
|
||||
|
||||
Reference in New Issue
Block a user