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

Add WSL guide #317

Merged
merged 1 commit into from
Jul 29, 2021
Merged

Add WSL guide #317

merged 1 commit into from
Jul 29, 2021

Conversation

rmccue
Copy link
Member

@rmccue rmccue commented Jul 29, 2021

Fixes #308.

@rmccue rmccue requested a review from roborourke July 29, 2021 10:52
Copy link
Contributor

@roborourke roborourke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The information online is kinda confusing, it seems Home edition can support this using some other system based on Hyper-V, although full Hyper-V is better. As far as I understand it anyway.

We might be able to drop the section on the troubleshooting guide if so, or at least update it to point back to this doc.

Comment on lines +3 to +5
Altis Local Server supports running on Windows 10 through the use of Docker Desktop and Windows Subsystem for Linux (WSL). Support for Hyper-V is required, which is available on Windows 10 Professional and Enterprise editions.

**Note:** Hyper-V virtualization and networking is not available in Windows 10 Home edition. If you are using Windows 10 Home Edition you will need to use the [Local Chassis](docs://local-chassis) environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For WSL2 you only need "Virtual Machine Platform" (a subset of Hyper-V) and "Windows Subsystem for Linux" features, both available in Home edition.

https://teckangaroo.com/enable-windows-10-virtual-machine-platform/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, technically that's true, but the UI actually confuses them in a few places. It does look like the Docker docs say it works on Home now though.

I don't have a test environment to do so though, and not sure if we really want to support it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let’s proceed with this then and see what comes out of support in future

@roborourke roborourke merged commit 57f7cb8 into master Jul 29, 2021
@roborourke roborourke deleted the add-wsl-docs branch July 29, 2021 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document full set up steps for WSL2
2 participants