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

https://github.com/sonodima/webos-unclutter

Remove the unwanted clutter from your WebOS TV
https://github.com/sonodima/webos-unclutter

Last synced: about 2 months ago
JSON representation

Remove the unwanted clutter from your WebOS TV

Awesome Lists containing this project

README

        

WebOS Unclutter 🧼

> Remove the unwanted clutter from your WebOS TV.

## Why?

Modern TVs are great, but are full of bloatware and telemetry.

This project aims to non-destructively block the telemetry of the webOS services you don't use.

## Supported TVs

This project has been built around the telemetry registered on an European LG C1 on webOS 6.0

Other webOS versions (or TVs in different regions) may communicate to different servers, and would probably require the addition of new rules in the blacklist.

If you have a different webOS version, please run this program with `allowed=true` in the `logging` configuration section and open an issue with the logged output.

## Installation

### Docker

Docker is the recommended way to run WebOS Unclutter.

You can use the following command to build and run the container for your architecture:

```bash
make docker
```

### Pre-built Binaries

You can download the latest pre-built binaries for your OS and architecture from the [releases page](https://github.com/sonodima/webos-unclutter/releases)

### From Source

Building WebOS Unclutter from source is easy, but you have to make sure you have the following dependencies installed:

- Go 1.19
- Make

```bash
make build
```

You can also specify the `GOOS` and `GOARCH` environment variables to cross-compile for a different OS and architecture.

```bash
GOOS=windows GOARCH=arm64 make build
```

#### About macOS U2B

The mach-o binary format allows the creation of binaries that can be run on both Intel and Apple Silicon _(M1)_ processors, however, this is not supported when cross-compiling from a different OS.

For this reason, when building for macOS on a non-macOS machine, the build will only produce a THIN (single-architecture) binary for the current architecture.

## TV Setup

Setting up your TV is easy, and you don't need developer mode enabled.

Go in the network settings of your TV, enable the manual network configuration and set the DNS address to the IP address of the machine running WebOS Unclutter.

### Having issues? [Manual DNS Settings](https://www.lg.com/us/support/help-library/manual-dns-settings-webos-CT10000020-20150576570174)

## Configuration

WebOS Unclutter uses a configuration file to know what to remove from your TV.

The configuration file is optional, and if not provided, the default configuration will be used.

### Structure

```yaml
network:
listen_port: 53
resolver: 8.8.8.8:53

logging:
blocked: true
allowed: false

blocking:
lg_smart_ad: true
home_dashboard: true
sports: true
app_store: true
internet_channels: true
lg_iot: true
amazon: true
philips_hue: true
software_updates: true
```

## Environment Variables

| Name | Description | Default |
| -------- | ----------------------------------- | ------------ |
| `CONFIG` | Name of the YAML configuration file | `config.yml` |