docs: reorder appview setup to start Redis before watch-appview #1118

The appview crashes on startup if Redis is not running:

appview: failed to start appview err="failed to start oauth handler:
failed to connect to redis: dial tcp [::1]:6379: connect: connection refused"

Reorder the "Running the appview" section so the Redis and OAuth JWKs prerequisites come before the watch-appview command, matching the actual dependency order.

Signed-off-by: Alessio Caiazza code.git@caiazza.info

+17 -17

1 changed file

Diff round #0

expand all

docs

DOCS.md

+17 -17

docs/DOCS.md

··· 1470 1470 1471 1471 ## Running the appview 1472 1472 1473 - The Nix flake also exposes a few `app` attributes (run `nix 1474 - flake show` to see a full list of what the flake provides), 1475 - one of the apps runs the appview with the `air` 1476 - live-reloader: 1473 + The appview requires Redis and OAuth JWKs. Start these 1474 + first, before launching the appview itself. 1477 1475 1478 1476 ```bash 1479 - TANGLED_DEV=true nix run .#watch-appview 1480 - 1481 - # TANGLED_DB_PATH might be of interest to point to 1482 - # different sqlite DBs 1483 - 1484 - # in a separate shell, you can live-reload tailwind 1485 - nix run .#watch-tailwind 1486 - ``` 1487 - 1488 - To authenticate with the appview, you will need Redis and 1489 - OAuth JWKs to be set up: 1490 - 1491 - ``` 1492 1477 # OAuth JWKs should already be set up by the Nix devshell: 1493 1478 echo $TANGLED_OAUTH_CLIENT_SECRET 1494 1479 z42ty4RT1ovnTopY8B8ekz9NuziF2CuMkZ7rbRFpAR9jBqMc ··· 1511 1496 redis-server 1512 1497 ``` 1513 1498 1499 + The Nix flake exposes a few `app` attributes (run `nix 1500 + flake show` to see a full list of what the flake provides), 1501 + one of the apps runs the appview with the `air` 1502 + live-reloader: 1503 + 1504 + ```bash 1505 + TANGLED_DEV=true nix run .#watch-appview 1506 + 1507 + # TANGLED_DB_PATH might be of interest to point to 1508 + # different sqlite DBs 1509 + 1510 + # in a separate shell, you can live-reload tailwind 1511 + nix run .#watch-tailwind 1512 + ``` 1513 + 1514 1514 ## Running knots and spindles 1515 1515 1516 1516 An end-to-end knot setup requires setting up a machine with

History

1 round 1 comment

nolith.dev submitted #0 11d

1 commit

expand

62cfea5a

docs: reorder appview setup to start Redis before watch-appview

expand 1 comment

oppi.li 8d

lgtm!

pull request successfully merged