diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-06-03 14:42:44 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-06-03 14:42:44 +0300 |
| commit | 5b2fce600f7688059e8ae245da7c6ffc561bb92a (patch) | |
| tree | 0414c31c4d2317830d4de220c44eeb84b7e48110 /docs/next/website/src | |
| parent | e584f93f367650a2b752a4e3a889603fb81b08f4 (diff) | |
docs: finalize next release docs
refs #354
refs #439
Diffstat (limited to 'docs/next/website/src')
| -rw-r--r-- | docs/next/website/src/content/docs/configuration.mdx | 22 | ||||
| -rw-r--r-- | docs/next/website/src/content/docs/persistence-remote.mdx | 2 |
2 files changed, 24 insertions, 0 deletions
diff --git a/docs/next/website/src/content/docs/configuration.mdx b/docs/next/website/src/content/docs/configuration.mdx index 4074d791..f9bf47f1 100644 --- a/docs/next/website/src/content/docs/configuration.mdx +++ b/docs/next/website/src/content/docs/configuration.mdx @@ -33,6 +33,17 @@ Herdr shows first-run setup when `onboarding` is missing or true. Continuing fro onboarding = false ``` +## Update channel + +Direct installs use the stable update channel by default. + +```toml +[update] +channel = "stable" +``` + +Set `channel = "preview"` to make `herdr update` install preview builds from the current development branch. Homebrew and Nix installs ignore the preview channel and update through their package managers. + ## Reload config Reload a running server after editing `config.toml`: @@ -91,6 +102,17 @@ Grouped worktrees still behave like normal Herdr workspaces: they can be focused Deleting a worktree checkout is explicit. Use `Delete worktree checkout...` on a grouped child workspace to run `git worktree remove`. Herdr first asks Git to remove safely. If Git refuses because the checkout has modified or untracked files, Herdr asks again before running the forced remove. Branches are not deleted. +## Remote attach + +Remote attach manages its SSH bridge with a temporary keepalive fallback by default. + +```toml +[remote] +manage_ssh_config = true +``` + +When enabled, `herdr --remote` writes a private temporary SSH config that includes your `~/.ssh/config` and `/etc/ssh/ssh_config` first, then adds fallback `ServerAliveInterval` and `ServerAliveCountMax` values. Your own SSH keepalive settings win. Set `manage_ssh_config = false` to run the bridge through plain `ssh` without Herdr's generated config. + ## Keybindings Herdr has a prefix mode similar to tmux. The default prefix is `ctrl+b`. Keybinding strings are explicit: `prefix+n` means press the configured prefix and then `n`; `ctrl+alt+n` is a direct terminal-mode shortcut. diff --git a/docs/next/website/src/content/docs/persistence-remote.mdx b/docs/next/website/src/content/docs/persistence-remote.mdx index 987a2154..7ffffb7f 100644 --- a/docs/next/website/src/content/docs/persistence-remote.mdx +++ b/docs/next/website/src/content/docs/persistence-remote.mdx @@ -92,6 +92,8 @@ herdr --remote workbox Remote attach supports Linux and macOS hosts on x86_64 and aarch64. Herdr checks the remote platform, prefers a matching `herdr` already on the remote `PATH`, then checks `~/.local/bin/herdr`. If no matching binary exists, interactive runs prompt to install one to `~/.local/bin/herdr`; non-interactive runs fail instead of modifying the host. If `~/.local/bin` is not on the remote `PATH`, Herdr warns after install. +By default, `herdr --remote` runs the bridge through a temporary SSH config that includes your SSH config first, then adds fallback keepalive settings. Existing user keepalive settings win. Set `[remote].manage_ssh_config = false` to use plain `ssh` without Herdr's generated bridge config. + By default, remote attach uses the normal restart/stop flow if it needs to replace or restart a running remote server. To opt into experimental live handoff for a supported running remote server, pass `--handoff`: ```bash |
