Skip to content

chore(docs): s/ENVBUILDER_GIT_SSH_KEY_PATH/ENVBUILDER_GIT_SSH_PRIVATE_KEY_PATH/g #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 9, 2024
Merged

chore(docs): s/ENVBUILDER_GIT_SSH_KEY_PATH/ENVBUILDER_GIT_SSH_PRIVATE_KEY_PATH/g #308

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef6be02
chore(docs): s/ENVBUILDER_GIT_SSH_KEY_PATH/ENVBUILDER_GIT_SSH_PRIVATE…
johnstcn Aug 9, 2024
c73ee7f
Merge branch 'main' into cj/fix-ssh-key-docs
johnstcn Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ resource "docker_container" "dev" {
If `ENVBUILDER_GIT_URL` does not start with `http://` or `https://`,
envbuilder will assume SSH authentication. You have the following options:

1. Public/Private key authentication: set `ENVBUILDER_GIT_SSH_KEY_PATH` to the path of an
1. Public/Private key authentication: set `ENVBUILDER_GIT_SSH_PRIVATE_KEY_PATH` to the path of an
SSH private key mounted inside the container. Envbuilder will use this SSH
key to authenticate. Example:

Expand All @@ -185,7 +185,7 @@ envbuilder will assume SSH authentication. You have the following options:
-v /tmp/envbuilder:/workspaces \
-e ENVBUILDER_GIT_URL=git@example.com:path/to/private/repo.git \
-e ENVBUILDER_INIT_SCRIPT=bash \
-e ENVBUILDER_GIT_SSH_KEY_PATH=/.ssh/id_rsa \
-e ENVBUILDER_GIT_SSH_PRIVATE_KEY_PATH=/.ssh/id_rsa \
-v /home/user/id_rsa:/.ssh/id_rsa \
ghcr.io/coder/envbuilder
```
Expand Down