docs: v1.0.0 — full documentation update
- ROADMAP.md: mark all v0.9.8–v0.9.10 items shipped; Phase 4 accountability features complete; v1.0 criteria all met; update to reflect current state as of v0.9.10 - DEPLOYING.md: add SMTP/email section, ENCRYPTION_SECRET_KEY entry, fix OPENAI_MODEL default (gpt-4o → gpt-4o-mini), add pocketveto.org reference - UPDATING.md: replace personal git remote with YOUR_GIT_REMOTE placeholder for public deployability - ARCHITECTURE.md: add member_scores table, alignment API, LLM Batch API, email unsubscribe, bill tab UI, topic tags constant, Fernet encryption pattern, feature history through v0.9.10 Authored by: Jack Levy
This commit is contained in:
15
DEPLOYING.md
15
DEPLOYING.md
@@ -28,6 +28,7 @@ Google Trends (`pytrends`) needs no key.
|
||||
|
||||
```bash
|
||||
git clone https://git.jackhlevy.com/jack/civicstack.git
|
||||
# (Replace with your own fork URL or download a release from pocketveto.org)
|
||||
cd civicstack
|
||||
```
|
||||
|
||||
@@ -50,6 +51,9 @@ PUBLIC_URL= # leave blank unless you have a public do
|
||||
# Auth — generate with: python -c "import secrets; print(secrets.token_hex(32))"
|
||||
JWT_SECRET_KEY=your-generated-secret
|
||||
|
||||
# Encryption key for sensitive prefs (generate once, never change after data is written)
|
||||
ENCRYPTION_SECRET_KEY= # generate: python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
|
||||
|
||||
# PostgreSQL
|
||||
POSTGRES_USER=congress
|
||||
POSTGRES_PASSWORD=your-strong-password
|
||||
@@ -64,7 +68,7 @@ DATA_GOV_API_KEY=your-api-key
|
||||
# LLM — pick one
|
||||
LLM_PROVIDER=openai
|
||||
OPENAI_API_KEY=sk-...
|
||||
OPENAI_MODEL=gpt-4o
|
||||
OPENAI_MODEL=gpt-4o-mini
|
||||
```
|
||||
|
||||
Other providers (swap in place of the OpenAI block):
|
||||
@@ -92,6 +96,15 @@ PYTRENDS_ENABLED=true # Google Trends; disable if hitting rate
|
||||
CONGRESS_POLL_INTERVAL_MINUTES=30 # how often to check Congress.gov
|
||||
```
|
||||
|
||||
```env
|
||||
# Email notifications (optional — requires SMTP relay, e.g. Resend)
|
||||
SMTP_HOST=smtp.resend.com
|
||||
SMTP_PORT=465
|
||||
SMTP_USER=resend
|
||||
SMTP_PASSWORD=re_your-api-key
|
||||
SMTP_FROM=alerts@yourdomain.com
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Build and start
|
||||
|
||||
Reference in New Issue
Block a user