An open API service indexing awesome lists of open source software.

https://github.com/developerscommunity/archlinux-wsl

Custom Arch Linux distribution for WSL
https://github.com/developerscommunity/archlinux-wsl

arch arch-linux archlinux archlinux-wsl archwsl linux wsl wsl-arch wsl-archlinux wsl-distro wsl2

Last synced: about 1 month ago
JSON representation

Custom Arch Linux distribution for WSL

Awesome Lists containing this project

README

          

# Archived

Use the official distribution

```powershell
wsl --install archlinux
```

# Custom Arch Linux distribution for WSL

This is an automated script to create an [Arch Linux](https://archlinux.org)
[WSL](https://aka.ms/wsl/) [modern
distribution](https://learn.microsoft.com/windows/wsl/build-custom-distro).

You can download a pre-built version from the [releases
page](https://github.com/DevelopersCommunity/archlinux-wsl/releases/latest). Get
the `.wsl` file and double-click it in `File Explorer` to install the
distribution.

## Requirements

You need [WSL release 2.4.4 or higher](https://github.com/microsoft/WSL/releases)
to use this installation method. To update WSL, run the following command:

```powershell
wsl --update
```

To build the distribution, you need the following tools:

- [Docker Engine](https://docs.docker.com/engine/). On Windows, you can build
the distribution using [WSL with Docker
support](https://docs.docker.com/desktop/features/wsl/).
- [Docker Buildx](https://docs.docker.com/build/concepts/overview/)
- [Docker personal access
token](https://docs.docker.com/security/for-developers/access-tokens/)
- [curl](https://curl.se/)
- [Node.js](https://nodejs.org/)
- [jq](https://jqlang.github.io/jq/)
- [grep](https://www.gnu.org/software/grep/)
- [fakeroot](https://man.archlinux.org/man/fakeroot.1)

## Build

Before building, create a `.env` file with your Docker credentials:

```env
DOCKER_HUB_USERNAME=
DOCKER_HUB_PAT=
```

Then run the [`build`](./build) script to create the `archlinux.wsl` file.

## Windows Terminal profile

The build process creates a custom profile for the [Windows
Terminal](https://learn.microsoft.com/windows/terminal/). The color scheme is a
[Material Design dynamically generated color
scheme](https://m3.material.io/styles/color/dynamic/choosing-a-source) based on
the [Arch Linux logo](https://archlinux.org/art/) blue color. The script to
generate the profile is available in the [`terminal-profile`
directory](./terminal-profile/).

## Arch Linux trademark

The logo used in this distribution was taken from the [Arch Linux logos and
artwork page](https://archlinux.org/art/), and I believe its usage in this
project fits the [permitted
use](https://wiki.archlinux.org/title/DeveloperWiki:TrademarkPolicy#Permitted_Use)
condition from their trademark policy.