You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/setup/quickstart.md
+25-5Lines changed: 25 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,27 +21,47 @@ cd gordie
21
21
uv run gordie init
22
22
```
23
23
24
-
The setup wizard writes `.env`, verifies Docker is installed, prompts for your chat medium, LLM provider, Yahoo app credentials, and skips hosted billing unless you pass `--hosted`.
24
+
The setup wizard writes `.env`, verifies Docker is installed, prompts for your chat medium, LLM provider, Yahoo app credentials, starts the Docker Compose stack, and skips hosted billing unless you pass `--hosted`.
25
25
It also detects `ngrok`, offers to install it when it is missing, asks for your ngrok authtoken, briefly starts ngrok to detect your stable dev-domain URL, and writes that URL as `OAUTH_BASE_URL`. If you skip that automation, enter an existing public HTTPS URL and ngrok authtoken manually. The Docker connector sends tunnel traffic to `http://server:8000`.
26
26
27
-
## 2. Start Postgres + the server
27
+
## 2. Confirm Postgres + the server are running
28
28
29
29
```bash
30
-
docker compose up -d
31
30
curl http://localhost:8000/health
32
31
# {"status":"ok"}
33
32
```
34
33
35
34
The server applies Alembic migrations automatically before it starts accepting requests. The ngrok connector starts in the same Compose stack, so your public hostname should reach the same `/health` endpoint.
36
35
36
+
If the health check fails, check the running services first:
37
+
38
+
```bash
39
+
docker compose ps
40
+
docker compose logs -f server ngrok
41
+
```
42
+
43
+
Common fixes:
44
+
- Docker is not running: start Docker Desktop, then run `docker compose up -d --build`.
45
+
- Port `8000` is occupied: stop the other process or change the server port before restarting Compose.
46
+
- Startup validation fails: fix the missing or invalid `.env` value shown in the server log, then rerun `uv run gordie init`.
47
+
- ngrok fails: confirm `NGROK_AUTHTOKEN` in `.env`, then check `docker compose logs -f ngrok`.
48
+
- Public health fails: run `curl "$OAUTH_BASE_URL/health"` and confirm Yahoo uses the same base URL plus `/callback`.
49
+
50
+
Run Compose manually only if setup was interrupted before Docker startup, you intentionally skipped startup, you changed `.env` or `docker-compose.yml` after setup, or the services are stopped later:
51
+
52
+
```bash
53
+
docker compose up -d --build
54
+
curl http://localhost:8000/health
55
+
```
56
+
37
57
## 3. Send Gordie a message without configuring email
`uv run gordie init` starts the Docker Compose stack by default. Restart it manually only if you changed `.env` after setup, skipped Docker startup, or the services are stopped:
51
51
52
52
```bash
53
-
docker compose up -d
53
+
docker compose up -d --build
54
54
```
55
55
56
+
If local health fails, run `docker compose ps` and `docker compose logs -f server ngrok`.
57
+
If the public callback fails, run `curl "$OAUTH_BASE_URL/health"` and confirm Yahoo is configured with `OAUTH_BASE_URL` plus `/callback`.
58
+
56
59
## 4. Connect your league
57
60
58
61
Send a first message to Gordie:
59
62
60
63
```bash
61
-
uv run python scripts/message_agent.py --email you@example.com --message"hi"
64
+
uv run python scripts/message_agent.py you@example.com "hi"
62
65
```
63
66
64
67
Gordie replies with an OAuth link. Visit the URL, approve, get redirected back to `/callback?code=...`. Tokens land in `data/platform.db` (or the `yahoo_tokens` table in your Postgres if you've migrated to it).
0 commit comments