From b1d5bb86679fcfcdca1dcc48a85c92a50e137257 Mon Sep 17 00:00:00 2001 From: Vinfall <91039000+Vinfall@users.noreply.github.com> Date: Sun, 6 Nov 2022 02:30:25 +0000 Subject: [PATCH] Add init & telemetry info --- README.md | 44 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8855987..b9c397e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ based on [wsldl](https://github.com/yuk7/wsldl). [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) ![License](https://img.shields.io/github/license/Vinfall/ClearWSL.svg?style=flat-square) -**Notice: This is Clear Linux OS backed by Intel. Not to be confused with Clear OS, which is a completely different CentOS/RHEL-based distro.** +**Notice: This is *Clear Linux OS* backed by Intel. Not to be confused with *Clear OS*, which is a completely different CentOS/RHEL-based distro.** ## Requirements * Windows 10 Fall Creators Update x64 or later. @@ -21,8 +21,43 @@ based on [wsldl](https://github.com/yuk7/wsldl). Exe filename is using to the instance name to register. If you rename it, you can register with a different name and have multiple installs. -## How-to-Use(for Installed Instance) -#### exe Usage +## Init + +For now there would be a warning `WSL (XX) ERROR: CreateProcessEntryCommon:XXX: getpwuid(0) failed 2` during startup, but it's harmless despite annoying. +I will accept and appreciate it if anyone opens a PR regarding this! + +By default, ClearWSL comes with no `sudo` package. +To install `sudo` and make it function properly: +```sh +# Create /etc/passwd as it's not available by default +passwd +# Install `sudo` +swupd bundle-add --assume=yes sudo +# Check update +sudo swupd check-update +# Update +sudo swupd update +``` + +## Telemetrics + +It's worth mentioning that Clear Linux OS has a [built-in telemetry function](https://clearlinux.github.io/clear-linux-documentation/guides/clear/telemetrics.html) and **opt-in** by default. In ClearWSL the client is *not* active (maybe due to the fact that SystemD needs to be explicitly enabled in `/etc/wsl.conf`). + +If you use SystemD, it's better to ensure the telemetrics are disabled if you don't want this feature: +```sh +# Disabling after install +sudo telemctl stop +# Opt out of telemetry +sudo telemctl opt-out +``` + +If you get `sudo: telemctl: command not found`, it means that you don't have `telemetrics` bundle installed, so no worries about telemetry. + +For further information, please read [the official documentation for Clear Linux* Project](https://clearlinux.github.io/clear-linux-documentation/guides/clear/telemetrics.html#id9). + +## How-to-Use (for Installed Instance) + +### exe Usage ```dos Usage : @@ -48,8 +83,7 @@ Usage : - Print this usage message. ``` - -#### How to uninstall instance +### How to uninstall instance ```dos >Clear.exe clean ```