malpercio.dev
WIP! A BB-style forum, on the ATmosphere!
We're still working... we'll be back soon when we have something to show off!
node
typescript
hono
htmx
atproto
docs: sync README and deployment guide with codebase state (#83)
README was missing 3 of 5 packages (atproto, cli, logger).
Deployment guide had SESSION_TTL_DAYS default wrong (30 vs actual 7)
and was missing LOG_LEVEL, SEED_DEFAULT_ROLES, DEFAULT_MEMBER_ROLE
from the optional env vars table. Production env example was missing
FORUM_HANDLE and FORUM_PASSWORD variables.
+8
.env.production.example
+8
.env.production.example
···
55
55
# - Bluesky PDS: https://bsky.social
56
56
PDS_URL=https://pds.example.com
57
57
58
+
# Forum Service Account credentials
59
+
# Required for the AppView to write forum-level records (categories, roles, mod actions)
60
+
# to the PDS on behalf of the forum identity.
61
+
#
62
+
# Use the handle and password for the AT Protocol account created for your forum.
63
+
FORUM_HANDLE=forum.example.com
64
+
FORUM_PASSWORD=CHANGE_ME_STRONG_PASSWORD
65
+
58
66
# ============================================================================
59
67
# Application URLs
60
68
# ============================================================================
+3
README.md
+3
README.md
···
41
41
42
42
| Package | Description |
43
43
|---------|-------------|
44
+
| [`packages/atproto`](packages/atproto) | AT Protocol utilities: ForumAgent, error classification, identity resolution |
45
+
| [`packages/cli`](packages/cli) | Forum management CLI (`atbb`) for initializing forums, categories, and boards |
44
46
| [`packages/db`](packages/db) | Drizzle ORM schema and connection factory (PostgreSQL and SQLite/LibSQL) |
45
47
| [`packages/lexicon`](packages/lexicon) | AT Proto lexicon schemas (YAML) and generated TypeScript types |
48
+
| [`packages/logger`](packages/logger) | Structured logging with OpenTelemetry and Hono middleware support |
46
49
47
50
## Getting Started
48
51
+2
-2
docker-compose.example.yml
+2
-2
docker-compose.example.yml
···
142
142
# CRITICAL: Generate with: openssl rand -hex 32
143
143
SESSION_SECRET: ${SESSION_SECRET}
144
144
145
-
# Optional: Session TTL (defaults to 30 days if not set)
146
-
# SESSION_TTL_DAYS: ${SESSION_TTL_DAYS:-30}
145
+
# Optional: Session TTL (defaults to 7 days if not set)
146
+
# SESSION_TTL_DAYS: ${SESSION_TTL_DAYS:-7}
147
147
148
148
# Optional: Jetstream firehose URL (uses default if not set)
149
149
# JETSTREAM_URL: ${JETSTREAM_URL:-wss://jetstream2.us-east.bsky.network/subscribe}
+4
-1
docs/deployment-guide.md
+4
-1
docs/deployment-guide.md
···
281
281
| `WEB_PORT` | `3001` | Web UI port (internal) |
282
282
| `APPVIEW_URL` | `http://localhost:3000` | Internal API URL (keep as localhost for single container) |
283
283
| `JETSTREAM_URL` | `wss://jetstream2.us-east.bsky.network/subscribe` | AT Protocol firehose URL |
284
-
| `SESSION_TTL_DAYS` | `30` | Session lifetime in days (1-90 range) |
284
+
| `SESSION_TTL_DAYS` | `7` | Session lifetime in days (1-90 range) |
285
285
| `REDIS_URL` | (none) | Redis connection string (future: multi-instance deployments) |
286
+
| `LOG_LEVEL` | `info` | Log verbosity: `debug`, `info`, `warn`, `error`, `fatal` |
287
+
| `SEED_DEFAULT_ROLES` | `true` | Set to `false` to disable automatic role seeding on startup |
288
+
| `DEFAULT_MEMBER_ROLE` | (none) | Role name to auto-assign to new memberships |
286
289
287
290
### Security Best Practices
288
291