Skip to content
This repository has been archived by the owner on May 18, 2024. It is now read-only.

Commit

Permalink
Add init & telemetry info
Browse files Browse the repository at this point in the history
  • Loading branch information
Vinfall authored Nov 6, 2022
1 parent 683f18e commit b1d5bb8
Showing 1 changed file with 39 additions and 5 deletions.
44 changes: 39 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 :
<no args>
Expand All @@ -48,8 +83,7 @@ Usage :
- Print this usage message.
```


#### How to uninstall instance
### How to uninstall instance
```dos
>Clear.exe clean
```
Expand Down

0 comments on commit b1d5bb8

Please sign in to comment.