Skip to content
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.

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

Adding sugestions to install WSL2 and it packages in environment-setup.md #2400

Merged
merged 1 commit into from
Oct 31, 2021
Merged
Changes from all commits
Commits
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
19 changes: 17 additions & 2 deletions docs/environment-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@
- [Node.js (npm)](https://nodejs.org/en/download/)
- [Docker and Docker-Compose](https://docs.docker.com/install/)

## Install Redis and WSL2

1. Follow Microsoft WSL2 [installation guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to complete the installation. Suggest to run the following once in the WSL2 environment.

```bash
# fetch updated packages information
sudo apt update

# upgrade or install outdated packages
sudo apt upgrade
Grommers00 marked this conversation as resolved.
Show resolved Hide resolved
```

2. Suggest to install [Windows Terminal](https://docs.microsoft.com/en-us/windows/wsl/install-win10#install-windows-terminal-optional), it facilitates you to switch directories between WSL2 Ubuntu bash and Windows drive.
3. Suggest to install [Node, nvm and npm for WSL2](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl#install-nvm-nodejs-and-npm), so as to be able to use Node and npm in the subsystem.

## Docker and Docker-Compose Setup

### Linux-Ubuntu
Expand Down Expand Up @@ -134,12 +149,12 @@ _NOTE: This will not work on WSL (Windows Subsystem for Linux). Use the approach
1. Get [Docker for Desktop For Mac](https://hub.docker.com/editions/community/docker-ce-desktop-mac)
1. Docker for Desktop comes with docker-compose installed.

### Windows 10 Pro, Enterprise, or Education (Hyper-V)
### Windows 10 Pro, Enterprise, Education or Windows 11(Hyper-V)

1. Get [Docker for Desktop For Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
1. Docker for Desktop comes with docker-compose installed.

### Windows 10 Home, Pro, Enterprise, or Education (Insiders WSL 2 Docker)
### Windows 10 Home, Pro, Enterprise, Education (Insiders WSL 2 Docker)

1. If your [Windows build number](https://www.windowscentral.com/how-check-your-windows-10-build) is below [18917](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install/), join the [insiders program](https://insider.windows.com/en-us/). Then, update your machine to a newer build through Automatic Updates.
2. Once installed successfully, install [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install).
Expand Down