https://github.com/loft-sh/devpod-provider-ssh
DevPod on SSH
https://github.com/loft-sh/devpod-provider-ssh
Last synced: 9 months ago
JSON representation
DevPod on SSH
- Host: GitHub
- URL: https://github.com/loft-sh/devpod-provider-ssh
- Owner: loft-sh
- License: mpl-2.0
- Created: 2023-03-09T13:07:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T00:28:41.000Z (10 months ago)
- Last Synced: 2025-04-15T01:14:31.936Z (9 months ago)
- Language: Go
- Size: 10.6 MB
- Stars: 10
- Watchers: 3
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# DevPod SSH Provider
[](https://slack.loft.sh/) [](https://devpod.sh/open#https://github.com/loft-sh/devpod-provider-ssh)
This repository hosts the default SSH provider configuration used in DevPod.
## Usage
To add this SSH provider from the CLI, use the `provider add` command along with your remote host to deploy to. For example:
```shell
devpod provider add ssh -o HOST=user@my-domain.com
```
Please note, the SSH host must be accessible via ssh user@my-domain.com with passwordless login and the user being either root or in the docker group.
## Compatibility
We only support Linux machine as remote hosts.
### Windows
There are known issues with the default windows SSH installation in some setups. If you're unable to connect to your host by default,
try to enable the `USE_BUILTIN_SSH` option
```shell
devpod provider add ssh --option USE_BUILTIN_SSH=true
# or if already installed
devpod provider set-options ssh --option USE_BUILTIN_SSH=true
```
This forces the provider to use the builtin SSH client over the one accessible in your shell.
You will need to add the identities file manually to your SSH config in case it's not the default key:
```ssh
Host my-domain.com
User my-user
IdentityFile ~/.my-dir/my-key
```
## Options
This provider has the following options:
| NAME | REQUIRED | DESCRIPTION | DEFAULT |
|-----------------|----------|------------------------------------------------------------|-------------------|
| HOST | true | The SSH Host to connect to. Example: my-user@my-domain.com | |
| AGENT_PATH | false | The path where to inject the DevPod agent to. | /tmp/devpod/agent |
| DOCKER_PATH | false | The path of the docker binary. | docker |
| EXTRA_FLAGS | false | Extra flags to pass to the SSH command. | |
| PORT | false | The SSH port to use. | 22 |
| USE_BUILTIN_SSH | false | Use the builtin SSH package. | false |
# Extra
For more detail, see the [DevPod Documentation](https://devpod.sh/docs/managing-providers/what-are-providers).