diff --git a/documentation/HOWTO-join-the-table.md b/documentation/HOWTO-join-the-table.md index 15e773f90..275ab33b4 100644 --- a/documentation/HOWTO-join-the-table.md +++ b/documentation/HOWTO-join-the-table.md @@ -85,15 +85,19 @@ DX_SYNC_REMOTE=origin That is the only line you need. `.env.local` is never committed, so it stays yours. -> **`DX_SYNC_REMOTE` is the remote's NAME, not a URL.** For almost everyone that is `origin`. Leave it -> unset and the whole feature is off. +> **Either a remote name or a full repo URL works.** `origin` is what almost everyone wants. A URL — +> `https://…/your-repo.git` — works too and saves you a `git remote add`; if the repo is private it uses +> the git credentials your laptop already has. Leave it unset and the whole feature is off. +> +> If you do put a token in the URL (`https://user:token@…`), it is never written to the log or shown at +> `/api/dev-sync`. Two optional dials, if you want them: | | what it does | default | |---|---|---| | `DX_SYNC_BRANCH` | which branch to follow | `main` | -| `DX_SYNC_INTERVAL` | seconds between checks | `15` (minimum 5) | +| `DX_SYNC_INTERVAL` | seconds between checks | `5` (minimum 2) | **It only pulls when it is completely safe to.** All three must be true: you are on that branch, you have no unsaved edits, and you have no local commits. If any one of them is not, it does not touch your files —