🖥️Setup

Get started with LNXlink

Installation

Select the installation type you want:

System

Install LNXlink and it's dependencies. It will create a config.yaml file and it will guide you through the basic configuration setup:

curl -L https://raw.githubusercontent.com/bkbilly/lnxlink/master/install.sh | bash

You can manually update the configuration file config.yaml and restart the service with the use of systemctl:

systemctl --user restart lnxlink.service  # For user installations
sudo systemctl restart lnxlink.service  # For root installations

Flatpak

Install and follow the setup instructions by running it. A new configuration file will be created at ~/Documents/LNXlink/config.yaml.

flatpak install flathub io.github.bkbilly.lnxlink
flatpak run io.github.bkbilly.lnxlink

Some modules are not supported like bluetooth, sys_updates, boot_select.

You will also need to manually create a systemd service to start LNXlink on boot by creating a service file.

/etc/systemd/system/lnxlink.service

[Unit]
Description=LNXlink
After=network-online.target multi-user.target graphical.target
PartOf=graphical-session.target

[Service]
Type=simple
Restart=always
RestartSec=5

ExecStart=flatpak run io.github.bkbilly.lnxlink

[Install]
WantedBy=default.target

This must be enabled to start on boot:

sudo systemctl enable lnxlink.service
sudo systemctl daemon-reload

Docker

Docker is not recommended for desktop environments because it limits many modules which can't run properly. Firstly you should download LNXlink image and setup the config directory:

docker run --network host -v ~/Documents/LNXlink/:/opt/lnxlink/config/ -it bkbillybk/lnxlink:latest

Create a docker compose file:

docker-compose.yaml

version: "3"
services:
  lnxlink:
    image: bkbillybk/lnxlink:latest
    container_name: lnxlink
    restart: unless-stopped
    network_mode: host
    privileged: true
    stdin_open: true
    tty: true
    volumes:
      - ~/Documents/LNXlink/:/opt/lnxlink/config/
      - /var/run/reboot-required:/var/run/reboot-required:ro
      - /var/run/docker.sock:/var/run/docker.sock
      - /var/run/dbus/:/var/run/dbus/
      - /sys/block/:/sys/block/
      - /proc/:/proc/
      - /dev/:/dev/

Run docker compose image:

docker compose -f docker-compose.yaml up

Development

This installs LNXlink as a development platform which is helpful if you want to create your own changes or create a new module. Read on the Development section for more information.

# Fork my repository and then download it
git clone https://github.com/bkbilly/lnxlink.git
# Install lnxlink as editable package
cd lnxlink
pip3 install -e .
# Run it manually
lnxlink -c config.yaml

Run sudo commands

Some commands need to run as a root user. To fix this, you need to allow some of them to run without asking for password:

# Edit the sudoers file:
sudo visudo
# Add this line at the end (replace USER with your username):
USER ALL=(ALL) NOPASSWD: /usr/sbin/grub-reboot

Uninstall

Remove LNXlink from your system.

User

# Disables systemd service
systemctl --user disable lnxlink.service

# Remove systemd service
rm ~/.config/systemd/user/lnxlink.service

# Uninstall the package
pip3 uninstall -U lnxlink

Root

# Disables systemd service
sudo systemctl disable lnxlink.service

# Remove systemd service
sudo rm /etc/systemd/system/lnxlink.service

# Uninstall the package
sudo pip3 uninstall -U lnxlink
sudo pip3 uninstall lnxlink