Skip to content

Latest commit

 

History

History
249 lines (218 loc) · 14.8 KB

README.md

File metadata and controls

249 lines (218 loc) · 14.8 KB

Extras

This is where extra functionality scripts can be found. These are not incorporated in the main tch-gui-unhide code line, because they rely on additional packages being installed or some other manual intervention.

Extras scripts that rely on packages to be installed require opkg to be configured correctly on your device. See opkg Configuration below.

tch-gui-unhide-xtra.adblock

Creates a GUI interface for the Adblock package that allows you to block ads at the router level. Note that the latest version supported of adblock is 4.2.3-3. Later versions require OpenWrt features not present in Technicolor firmware.

Firmware Applicability

Should be applicable to all firmware versions supported by tch-gui-unhide.

Prerequisites

Make sure you are in the directory in which the tch-gui-unhide script in installed, and then execute these commands to install the latest adblock package and all its required dependencies and configuration:
curl -kLO https://raw.githubusercontent.com/seud0nym/tch-gui-unhide/master/extras/tch-gui-unhide-xtra.adblock
sh tch-gui-unhide-xtra.adblock setup

Installation

./tch-gui-unhide -x adblock

Upgrading an existing adblock installation

sh tch-gui-unhide-xtra.adblock setup

Removal Instructions

  1. Run: sh tch-gui-unhide-xtra.adblock remove
  2. Delete /etc/config/adblock
  3. Delete tch-gui-unhide-xtra.adblock
  4. Re-run tch-gui-unhide to remove the GUI changes, and the additional transformer mappings

tch-gui-unhide-xtra.minidlna

Replaces the stock DLNA server management in the GUI so that it supports OpenWRT minidlna.

Firmware Applicability

Should be applicable to all firmware versions supported by tch-gui-unhide, except 20.4 as there is no compatible repository for firmware 20.4 packages.

Prerequisites

Install minidlna using the opkg command (see opkg Configuration below): opkg install minidlna

Installation

./tch-gui-unhide -x minidlna

Removal Instructions

  1. Do not delete tch-gui-unhide-xtra.minidlna
  2. Remove minidlna: opkg remove minidlna
  3. Re-run tch-gui-unhide to remove the GUI changes, custom configuration and the additional transformer mappings
  4. Now you can delete tch-gui-unhide-xtra.minidlna

tch-gui-unhide-xtra.rsyncd

Adds the ability to enable and disable the rsync daemon from the GUI.

  • Adds the home module to /etc/rsyncd.conf to allow read/write access to the /root directory via rsync (e.g. rsync 192.168.0.1::home)
  • Adds the tmp module to /etc/rsyncd.conf to allow read/write access to the /tmp directory via rsync (e.g. rsync 192.168.0.1::tmp)
  • Adds the usb module to /etc/rsyncd.conf to allow read/write access to the USB device via rsync (e.g. rsync 192.168.0.1::usb)

Firmware Applicability

Should be applicable to all firmware versions supported by tch-gui-unhide, except 20.4 as there is no compatible repository for firmware 20.4 packages.

Prerequisites

Install rsyncd using the opkg command (see opkg Configuration below): opkg install rsync rsyncd

Installation

./tch-gui-unhide -x rsyncd

Removal Instructions

  1. Delete tch-gui-unhide-xtra.rsyncd
  2. Remove rsyncd: opkg remove rsync rsyncd
  3. Re-run tch-gui-unhide to remove the GUI changes, and the additional transformer mappings

tch-gui-unhide-xtra.samba36-server

Correctly configures OpenWRT SAMBA 3.6 to provide SMBv2 for Windows 10 inter-operability. This update adds the ability to change the password via the GUI.

Firmware Applicability

You should only install SAMBA 3.6 on the 17.2 and 18.1.c firmware. The 20.3.c and later firmware contains NQE rather than SAMBA, and do not require the SAMBA 3.6 update to upgrade to SMBv2 and inter-operate with Windows 10.

Prerequisites

Install SAMBA v3.6 using the opkg command (see opkg Configuration below): opkg --force-overwrite install samba36-server

Installation

./tch-gui-unhide -x samba36-server

Removal Instructions

  1. Do not delete tch-gui-unhide-xtra.samba36-server
  2. Remove samba36-server: opkg remove samba36-server
  3. Re-run tch-gui-unhide to correctly restore the default version of SAMBA on the device and remove the GUI changes, the custom configuration and the additional transformer mappings
  4. Now you can delete tch-gui-unhide-xtra.samba36-server

tch-gui-unhide-xtra.speedtest

Creates a GUI interface for the Ookla Speedtest® CLI.

Firmware Applicability

Should be applicable to all firmware versions supported by tch-gui-unhide with release 2023.06.20 or later, running on ARM-based devices (not MIPS).

Prerequisites

Make sure you are in the directory in which the tch-gui-unhide script in installed, and then execute these commands:
./update-ca-certificates
Execute these commands to install the latest Speedtest® CLI where it is expected by tch-gui-unhide:
mkdir /root/ookla
For all ARM-based hardware prior to and including Telstra Smart Modem Gen 2:
   curl -kL https://install.speedtest.net/app/cli/ookla-speedtest-1.2.0-linux-armel.tgz | tar -xz -C /root/ookla
For Telstra Smart Modem Gen 3:
   curl -kL https://install.speedtest.net/app/cli/ookla-speedtest-1.2.0-linux-aarch64.tgz | tar -xz -C /root/ookla

Installation

./tch-gui-unhide -x speedtest

Removal Instructions

  1. Delete tch-gui-unhide-xtra.speedtest
  2. Re-run tch-gui-unhide to remove the GUI changes, and the additional transformer mappings
  3. (Optional) Delete the Speedtest directory: rm -rf /root/ookla

tch-gui-unhide-xtra.wireguard

Creates a GUI interface for configuring the Wireguard VPN.

Firmware Applicability

For firmware 20.3.c and 21.4.

  • All other firmware has not been compiled with TUN support in the kernel, and therefore VPN tunnels cannot be created.

Prerequisites

Ensure opkg in configured correctly (see opkg Configuration below). Then, add the openwrt-wireguard-go repository and install the package with these commands:
grep -q '/openwrt-wireguard-go/' /etc/opkg/customfeeds.conf || echo 'src/gz wg_go https://raw.githubusercontent.com/seud0nym/openwrt-wireguard-go/master/repository/arm_cortex-a9/base' >> /etc/opkg/customfeeds.conf
opkg update
opkg install wireguard-go

IPv6 ULA Prefix

If you are using IPv6, you need an IPv6 ULA (Unique Local Addresses) prefix. This can be configured on the Local Network card. If you do not configure your own ULA prefix and your network is configured for IPv6, the installation script will create a random one for you. IMPORTANT: Because these devices have no IPv6 NAT capability, IPv6 packets from client devices will NOT be sent via a WireGuard tunnel acting as a client to a remote VPN server. IPv6 traffic from the router itself will be routed via the tunnel. IPv4 traffic for both the router and client devices will be routed via the tunnel.

Dynamic DNS

If you are setting up a Wireguard VPN Server and your ISP/RSP provides your IPv4 address via DHCP, you should have a DNS entry pointing to your IPv4 address. This can be configured on the WAN Services card.
If you have a static IP address and a domain name assigned by your ISP, the domain name can still be entered under IPv4 Dynamic DNS, but you do not have to enable the Dynamic DNS Service.

Installation

./tch-gui-unhide -x wireguard

Removal Instructions

  1. Do not delete tch-gui-unhide-xtra.wireguard
  2. Uninstall openwrt-wireguard-go: wg --uninstall
  3. Re-run tch-gui-unhide to remove the GUI changes, custom configuration and firewall script
  4. Now you can delete tch-gui-unhide-xtra.wireguard

tch-gui-unhide-xtra.wlassoclist

Can be installed on a Technicolor device acting as a Wi-Fi Access Point (via a wired Ethernet connection) to enable the main Technicolor router (running tch-gui-unhide) to query it and correctly report devices connected via Wi-Fi, rather than showing them as Ethernet connections.

Firmware Applicability

All

Prerequisites

Each Access Point device with the wlassoclist extra script installed must have a static lease defined on the main router, and the lease must be assigned a Custom DHCP Options Tag that starts with AP_ followed by a descriptive name for the Access Point (e.g. AP_Living_Room or AP_Study or AP_DJA0230). The Custom DHCP Options Tag does not need to have any of the other fields defined (it is the name that is important).

Installation

./tch-gui-unhide -x wlassoclist

Removal Instructions

  1. Do not delete tch-gui-unhide-xtra.wlassoclist
  2. Run tch-gui-unhide -r to fully remove tch-gui-unhide
  3. Now you can delete tch-gui-unhide-xtra.wlassoclist
  4. Re-install tch-gui-unhide if required

How to download and execute these scripts

Using the tch-gui-unhide -x option

Use the -x option on the tch-gui-unhide command to download and apply the scripts. You can specify multiple -x options to install multiple extras scripts.

Manual Download

Download the scripts that you wish to execute into the same directory as tch-gui-unhide.

NOTE: Replace <scriptname> with the name of the script you wish to download.

Execute these commands on your device via a PuTTY session or equivalent (an active WAN/Internet connection is required):

curl -kLO https://raw.githubusercontent.com/seud0nym/tch-gui-unhide/master/extras/<scriptname>

Alternatively, download the script manually and load it up to your device using WinSCP or equivalent.

After you have the script on your device, you may need to make it executable, which is done with this command (assuming you are in the same directory as the script):

chmod +x <scriptname>

These scripts will be automatically run by tch-gui-unhide if they exist in the directory when it is executed. They are NOT intended to be executed outside of tch-gui-unhide.

opkg Configuration

Once you have correctly configured opkg using one of the following methods, you need to run the opkg update command before installing packages.

de-telstra

If you are are a de-telstra user, simply run it with -o option to correctly configure opkg on your device.

Manual Configuration

Edit the /etc/opkg/distfeeds.conf file and insert a # before the repository listed, otherwise you will get errors when updating, because that repository does not exist.

Edit the following files to configure opkg:

Firmware Versions starting with 17

  • /etc/opkg.conf
dest root /
dest ram /tmp
lists_dir ext /var/opkg-lists
option overlay_root /overlay
arch all 1
arch noarch 1
arch brcm63xx-tch 30
  • /etc/opkg/customfeeds.conf
src/gz base https://raw.githubusercontent.com/BoLaMN/brcm63xx-tch/master/packages/base
src/gz luci https://raw.githubusercontent.com/BoLaMN/brcm63xx-tch/master/packages/luci
src/gz management https://raw.githubusercontent.com/BoLaMN/brcm63xx-tch/master/packages/management
src/gz packages https://raw.githubusercontent.com/BoLaMN/brcm63xx-tch/master/packages/packages
src/gz routing https://raw.githubusercontent.com/BoLaMN/brcm63xx-tch/master/packages/routing
src/gz telephony https://raw.githubusercontent.com/BoLaMN/brcm63xx-tch/master/packages/telephony

Firmware Versions starting with 18 and 20.3

  • /etc/opkg.conf
dest root /
dest ram /tmp
lists_dir ext /var/opkg-lists
option overlay_root /overlay
arch all 1
arch noarch 1
arch brcm63xx-tch 30
arch arm_cortex-a9 10
arch arm_cortex-a9_neon 20
  • /etc/opkg/customfeeds.conf
src/gz chaos_calmer_base_macoers https://repository.macoers.com/homeware/18/brcm63xx-tch/VANTW/base
src/gz chaos_calmer_packages_macoers https://repository.macoers.com/homeware/18/brcm63xx-tch/VANTW/packages
src/gz chaos_calmer_luci_macoers https://repository.macoers.com/homeware/18/brcm63xx-tch/VANTW/luci
src/gz chaos_calmer_routing_macoers https://repository.macoers.com/homeware/18/brcm63xx-tch/VANTW/routing
src/gz chaos_calmer_telephony_macoers https://repository.macoers.com/homeware/18/brcm63xx-tch/VANTW/telephony
src/gz chaos_calmer_core_macoers https://repository.macoers.com/homeware/18/brcm63xx-tch/VANTW/target/packages
src/gz tch_coreutils https://raw.githubusercontent.com/seud0nym/tch-coreutils/master/repository/arm_cortex-a9/packages
src/gz tch_static https://raw.githubusercontent.com/seud0nym/tch-static/master/repository/arm_cortex-a9/packages

Firmware Versions starting with 20.4 and 21.4

There a very small number of packages available for firmware 20.4/21.4

  • /etc/opkg.conf
dest root /
dest ram /tmp
lists_dir ext /var/opkg-lists
option overlay_root /overlay
option check_signature
dest lcm_native /opt/
arch all 1
arch noarch 1
arch arm_cortex-a53 10
arch aarch64_cortex-a53 20
  • /etc/opkg/customfeeds.conf
src/gz tch_coreutils https://raw.githubusercontent.com/seud0nym/tch-coreutils/master/repository/arm_cortex-a53/packages
src/gz tch_static https://raw.githubusercontent.com/seud0nym/tch-static/master/repository/arm_cortex-a53/packages

After Manual Configuration

After configuring opkg, you need to update the package lists. You need to do this each time before you install any packages:

opkg update

You should also update the system CA certificates. You can do this either by:

  • preferably downloading and running the update-ca-certificates script; or
  • manually installing the CA certificates packages using: opkg install ca-certificates ca-bundle

The update-ca-certificates script will install the latest available certificates (and gives you the option to schedule a regular job to update them), whereas the opkg packages may not contain the latest certificates.

opkg update: wget returned 8

When using the macoers repository, you may see the error wget returned 8. The troubleshooting steps are:

  1. Make sure your CA certificates are up to date by running the update-ca-certificates script.
  2. Try and manually download a failed URL through your browser. This should alert you if your IP address has been banned by macoers.com. If that is the case, you should contact them directly and ask to be unblocked.

Packages Card in User Interface (after tch-gui-unhide applied)

If you have applied tch-gui-unhide, you can install/remove packages through the user interface. You do not need to do manual update of the package lists when using the user interface.