docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update dev-environments.md (#13906) 

* Update dev-environments.md

Include SSH agent instructions for WSL2 and Docker Dev Environments.

Refers to #13905.

* Added collapsible section

* Try wrapping codeblock around tildes

* Try using divs and code HTML tags

* Close divs

* Improve copy

* Update desktop/dev-environments.md

Co-authored-by: Djordje Lukic <lukic.djordje@gmail.com>

* Include more profile files

* Update desktop/dev-environments.md

Co-authored-by: Guillaume Lours <guillaume@lours.me>

* Apply suggestions from code review

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

Co-authored-by: Djordje Lukic <lukic.djordje@gmail.com>
Co-authored-by: Guillaume Lours <guillaume@lours.me>
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
This commit is contained in:
Felipe Cruz Martinez 2021-12-01 11:14:09 +01:00 committed by GitHub
parent 824f48ff30
commit 67f5be260b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
desktop/dev-environments.md
View File

@ -55,6 +55,38 @@ The simplest way to get started with Dev Environments is to create a new environ
>
> When cloning a Git repository using SSH, ensure you've added your SSH key to the ssh-agent. To do this, open a terminal and run `ssh-add <path to your private ssh key>`.
> **Note**
>
> If you have enabled the WSL 2 integration in Docker Desktop for Windows, make sure you have an SSH agent running in your WSL 2 distribution.
<div class="panel panel-default">
<div class="panel-heading collapsed" data-toggle="collapse" data-target="#collapse-wsl2-ssh" style="cursor: pointer">
How to start an SSH agent in WSL2
<i class="chevron fa fa-fw"></i></div>
<div class="collapse block" id="collapse-wsl2-ssh">
If your WSL 2 distribution doesn't have an `ssh-agent` running, you can append this script at the end of your profile file (that is: ~/.profile, ~/.zshrc, ...).
<pre><code>
SSH_ENV="$HOME/.ssh/agent-environment"
function start_agent {
echo "Initialising new SSH agent..."
/usr/bin/ssh-agent | sed 's/^echo/#echo/' > "${SSH_ENV}"
echo succeeded
chmod 600 "${SSH_ENV}"
. "${SSH_ENV}" > /dev/null
}
# Source SSH settings, if applicable
if [ -f "${SSH_ENV}" ]; then
. "${SSH_ENV}" > /dev/null
ps -ef | grep ${SSH_AGENT_PID} | grep ssh-agent$ > /dev/null || {
start_agent;
}
else
start_agent;
fi
</code></pre>
</div>
</div>
1. Click **Create New Environment**. This opens the **Create a Dev Environment** dialog. Copy `https://github.com/dockersamples/single-dev-env.git` and add it to the **Repository URL** field on the **Remote Git Repository** tab.
2. Now, click **Create**.