Skip to content

Commit 9bb8914

Browse files
AbbhiishekSonichigo
authored andcommitted
[docs]: Add Docker Desktop WSL 2 configuration reference to WSL/Linux installation docs (#443)
* refactor: window wsl doc Signed-off-by: Abhishek kushwaha <[email protected]> * refactor: docs navigation Signed-off-by: Abhishek kushwaha <[email protected]> * chore: Update QuickStart links and added wsl doc to Installation page Signed-off-by: Abhishek kushwaha <[email protected]> --------- Signed-off-by: Abhishek kushwaha <[email protected]> Signed-off-by: Animesh Pathak <[email protected]> Co-authored-by: Animesh Pathak <[email protected]>
1 parent d0ad877 commit 9bb8914

File tree

3 files changed

+27
-11
lines changed

3 files changed

+27
-11
lines changed

versioned_docs/version-2.0.0/concepts/installation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,22 @@ sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
110110
```bash
111111
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
112112
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
113+
113114
```
114115

115116
> Note: Keploy is not supported on MacOS natively.
116117
118+
### Setting up the Docker Desktop for WSL 2
119+
120+
1. Install Docker Desktop for Windows from [here](https://docs.docker.com/desktop/windows/install/).
121+
122+
When developing on Windows with Docker Desktop and WSL 2, it's crucial to configure Docker Desktop to allow WSL 2 distributions to access the Docker daemon. This setup enables seamless integration between your Windows environment, WSL 2 Linux distros, and Docker.
123+
124+
By default, Docker Desktop may not be configured to work with all WSL 2 distros out of the box. Proper configuration ensures that you can run Docker commands from within your WSL 2 environment, allowing for a more native Linux development experience while leveraging the power of Windows.
125+
126+
> This setup is essential for Keploy to function correctly in a WSL 2 environment, as it needs to interact with the Docker daemon to manage containers and networks effectively.
127+
> For detailed instructions on how to configure `Docker Desktop` for WSL 2, please refer to the [official Docker documentation](https://docs.docker.com/desktop/wsl/).
128+
117129
### With Arkade
118130

119131
1. Installing Arkade

versioned_docs/version-2.0.0/server/windows/installation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,18 @@ Voilà! 🧑🏻‍💻 We have the server running!
9090

9191
## Using Docker
9292

93+
### Setting up the Docker Desktop for WSL 2
94+
95+
1. Install Docker Desktop for Windows from [here](https://docs.docker.com/desktop/windows/install/).
96+
97+
When developing on Windows with Docker Desktop and WSL 2, it's crucial to configure Docker Desktop to allow WSL 2 distributions to access the Docker daemon. This setup enables seamless integration between your Windows environment, WSL 2 Linux distros, and Docker.
98+
99+
By default, Docker Desktop may not be configured to work with all WSL 2 distros out of the box. Proper configuration ensures that you can run Docker commands from within your WSL 2 environment, allowing for a more native Linux development experience while leveraging the power of Windows.
100+
101+
> This setup is essential for Keploy to function correctly in a WSL 2 environment, as it needs to interact with the Docker daemon to manage containers and networks effectively.
102+
103+
For detailed instructions on how to configure `Docker Desktop` for WSL 2, please refer to the [official Docker documentation](https://docs.docker.com/desktop/wsl/).
104+
93105
### Creating Alias
94106

95107
We need to create a custom network for Keploy since we are using the Docker, therefore application container would

versioned_sidebars/version-2.0.0-sidebars.json

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,7 @@
3535
"label": "CI/CD Integration",
3636
"collapsible": true,
3737
"collapsed": true,
38-
"items": [
39-
"ci-cd/github",
40-
"ci-cd/gitlab",
41-
"ci-cd/jenkins"
42-
]
38+
"items": ["ci-cd/github", "ci-cd/gitlab", "ci-cd/jenkins"]
4339
},
4440
{
4541
"type": "category",
@@ -116,18 +112,14 @@
116112
"label": "Rust",
117113
"collapsible": true,
118114
"collapsed": true,
119-
"items": [
120-
"quickstart/samples-rust"
121-
]
115+
"items": ["quickstart/samples-rust"]
122116
},
123117
{
124118
"type": "category",
125119
"label": "C# (.NET Core)",
126120
"collapsible": true,
127121
"collapsed": true,
128-
"items": [
129-
"quickstart/samples-csharp"
130-
]
122+
"items": ["quickstart/samples-csharp"]
131123
}
132124
]
133125
},

0 commit comments

Comments
 (0)