feat: Add SSH_CONFIG_INCLUDE_PATH option for read-only SSH configs #1944
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds support for read-only SSH config files (e.g., managed by Nix Home Manager.)
New context option
SSH_CONFIG_INCLUDE_PATHspecifies an alternate file where DevPodwrites host entries. Then the main SSH config can use an
Includedirective to loadDevPod-managed entries
Motivation
Users with declaratively managed SSH configs (Nix, chezmoi, etc.) cannot have DevPod modify
~/.ssh/configdirectly since it's read-only or regenerated. This change allows DevPod towrite its host entries to a separate file that can be included.
Usage
Add an Include directive to your SSH config file
~/.ssh/config:Configure DevPod to use the include path:
devpod context set-options -o SSH_CONFIG_INCLUDE_PATH=~/.ssh/devpod_hostsDevPod will now write workspace host entries to
~/.ssh/devpod_hostsinstead of~/.ssh/config.