README, HOWTO and .env.example: a changed port takes effect when bun run dev restarts (V8, third fresh reader)
A fresh reader given only the README and the HOWTO reached the Studio and a plugin's /__leaf page with nothing else needed, but one step. After "port 8090 is already in use ... set DX_PB_PORT", neither doc said the setting is read when bun run dev starts, so the new port only applies after a restart. The README copies .env.example before starting the server, and the port message appears only once it runs, so the steps looped with no stated way out. All three places that mention DX_PB_PORT now say to pick a free port and restart.
This commit is contained in:
parent
8a79e0f58a
commit
ef89113877
3 changed files with 5 additions and 3 deletions
|
|
@ -29,7 +29,8 @@ DX_SYNC_INTERVAL=
|
||||||
# serves it at /api/pb, admin UI /api/pb/_/, data in .pb/dev (gitignored). Nothing leaves this computer.
|
# serves it at /api/pb, admin UI /api/pb/_/, data in .pb/dev (gitignored). Nothing leaves this computer.
|
||||||
# Set to a PocketBase root (e.g. https://<your team's dev server>/pb) to use a shared team one instead.
|
# Set to a PocketBase root (e.g. https://<your team's dev server>/pb) to use a shared team one instead.
|
||||||
DX_PB_URL=
|
DX_PB_URL=
|
||||||
# The local PocketBase's port. Empty = 8090 (change it only if the log says the port is in use).
|
# The local PocketBase's port. Empty = 8090 (change it only if the log says the port is in use, then restart
|
||||||
|
# `bun run dev`: settings are read when it starts).
|
||||||
DX_PB_PORT=
|
DX_PB_PORT=
|
||||||
|
|
||||||
# ── Rudder, voice to text (backend/rudder-engine) ────────────────────────────────────────────────
|
# ── Rudder, voice to text (backend/rudder-engine) ────────────────────────────────────────────────
|
||||||
|
|
|
||||||
|
|
@ -712,7 +712,7 @@ bun run dev # → open the URL Vite prints: that page is the
|
||||||
|
|
||||||
No build needed first — the built maps are already in the repo. `bun run dev` also starts a local
|
No build needed first — the built maps are already in the repo. `bun run dev` also starts a local
|
||||||
PocketBase on port 8090 for the plugins that use a backend; it is downloaded on the first run (if 8090 is
|
PocketBase on port 8090 for the plugins that use a backend; it is downloaded on the first run (if 8090 is
|
||||||
taken, set `DX_PB_PORT` in `.env.local`). To start a
|
taken, set `DX_PB_PORT` to any free port in `.env.local` and restart `bun run dev`). To start a
|
||||||
plugin, copy `plugin-designs/template-bundle/` to `plugin-designs/<your-map>/`; the studio finds it
|
plugin, copy `plugin-designs/template-bundle/` to `plugin-designs/<your-map>/`; the studio finds it
|
||||||
automatically. Then rename it as its own `README.md` says. Each plugin also has its own page while
|
automatically. Then rename it as its own `README.md` says. Each plugin also has its own page while
|
||||||
`bun run dev` runs, at `/__leaf/<plugin>/<profile>` (for example `/__leaf/all-people-groups/all-people-groups`), and the
|
`bun run dev` runs, at `/__leaf/<plugin>/<profile>` (for example `/__leaf/all-people-groups/all-people-groups`), and the
|
||||||
|
|
|
||||||
|
|
@ -169,7 +169,8 @@ You sign in with the same team account you use for everything else — there is
|
||||||
whoever set up your team for the address. Leave the line out and you stay on your own local one, which is
|
whoever set up your team for the address. Leave the line out and you stay on your own local one, which is
|
||||||
the right place to be while you are finding your feet.
|
the right place to be while you are finding your feet.
|
||||||
|
|
||||||
The only other thing here is `DX_PB_PORT`, which you set only if the log says port 8090 is already in use.
|
The only other thing here is `DX_PB_PORT`, which you set only if the log says port 8090 is already in use: pick
|
||||||
|
any free port, then restart `bun run dev`, which reads these settings when it starts.
|
||||||
|
|
||||||
> **New collections start locked.** Your plugin's data is not readable until a migration opens it —
|
> **New collections start locked.** Your plugin's data is not readable until a migration opens it —
|
||||||
> deliberately, so nothing is public by accident. That migration is a commit like any other.
|
> deliberately, so nothing is public by accident. That migration is a commit like any other.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue