Skip to content

Commit

Permalink
GITBOOK-88: change request with no subject merged in GitBook
Browse files Browse the repository at this point in the history
  • Loading branch information
@bkbilly @gitbook-bot
bkbilly authored and gitbook-bot committed Aug 17, 2024
1 parent 022e805 commit 79efeb9
Show file tree
Hide file tree
Showing 6 changed files with 90 additions and 30 deletions.
Binary file added .gitbook/assets/logo (1).png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 26 additions & 25 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Effortlessly manage your Linux machine

# 🌩️ LNXlink

<figure><img src=".gitbook/assets/logo.png" alt=""><figcaption></figcaption></figure>
<figure><img src=".gitbook/assets/logo.png" alt="" width="256"><figcaption></figcaption></figure>

## Welcome

Expand All @@ -21,30 +21,31 @@ Home Assistant companion app for linux that uses the MQTT integration to get inf

The <mark style="color:orange;">Orange</mark> indicate that they need a graphical interface for them to work and the ones in <mark style="color:green;">Green</mark> need or support manual configuration.

| Controls | Sensors |
| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| <mark style="color:blue;">Shutdown</mark> | <mark style="color:blue;">CPU</mark> |
| <mark style="color:blue;">Restart</mark> | <mark style="color:blue;">RAM</mark> |
| <mark style="color:blue;">Suspend</mark> | <mark style="color:blue;">GPU</mark> |
| <mark style="color:blue;">Boot select</mark> | <mark style="color:blue;">Battery</mark> |
| <mark style="color:blue;">Power Profile</mark> | <mark style="color:blue;">Restart required</mark> |
| [<mark style="color:blue;">Speech Recognition</mark>](examples.md#voice-assistant) | <mark style="color:blue;">Network Speed</mark> |
| [<mark style="color:blue;">LNXlink Update</mark>](examples.md#install-update) | <mark style="color:blue;">Update required</mark> |
| <mark style="color:blue;">Bluetooth</mark> | <mark style="color:blue;">Network Interfaces</mark> |
| [<mark style="color:green;">Bash commands</mark>](settings.md#bash) | <mark style="color:blue;">Microphone used</mark> |
| [<mark style="color:green;">GPIO</mark>](settings.md#gpio) <mark style="color:green;">(inputs, outputs)</mark> | <mark style="color:blue;">Camera used</mark> |
| [<mark style="color:green;">IR Remote</mark>](settings.md#ir-remote) | <mark style="color:blue;">Gamepad Used</mark> |
| [<mark style="color:green;">SystemD</mark>](settings.md#systemd) | <mark style="color:blue;">Temperature</mark> |
| [<mark style="color:orange;">Keyboard Hotkeys</mark>](settings.md#keyboard-hotkeys) | <mark style="color:blue;">WiFi</mark> |
| [<mark style="color:orange;">Notify</mark>](examples.md#notification) | <mark style="color:blue;">Webcam show</mark> |
| [<mark style="color:orange;">Open URL/File</mark>](examples.md#open-a-url-or-file) <mark style="color:orange;">(xdg\_open)</mark> | <mark style="color:blue;">Inference Time</mark> |
| [<mark style="color:orange;">Send Keys</mark>](examples.md#keys-send) | [<mark style="color:green;">Statistics</mark>](examples.md#statistics) |
| <mark style="color:orange;">Mouse control</mark> | [<mark style="color:green;">Disk/Mounts usage</mark>](settings.md#disk-usage) |
| [<mark style="color:orange;">Media Controls</mark>](media-player.md) | <mark style="color:orange;">Fullscreen</mark> |
| <mark style="color:orange;">Screen On/Off</mark> | <mark style="color:orange;">Screenshot Show</mark> |
| <mark style="color:orange;">Audio Select (microphone, speaker)</mark> | <mark style="color:orange;">Display Variable</mark> |
| <mark style="color:orange;">Brightness</mark> | <mark style="color:orange;">Idle time</mark> |
| <mark style="color:orange;">Keep Alive</mark> | |
| Controls | Sensors |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| <mark style="color:blue;">Shutdown</mark> | <mark style="color:blue;">CPU</mark> |
| <mark style="color:blue;">Restart</mark> | <mark style="color:blue;">RAM</mark> |
| <mark style="color:blue;">Suspend</mark> | <mark style="color:blue;">GPU</mark> |
| <mark style="color:blue;">Boot select</mark> | <mark style="color:blue;">Battery</mark> |
| <mark style="color:blue;">Power Profile</mark> | <mark style="color:blue;">Restart required</mark> |
| [<mark style="color:blue;">Speech Recognition</mark>](examples.md#voice-assistant) | <mark style="color:blue;">Network Speed</mark> |
| [<mark style="color:blue;">LNXlink Update</mark>](examples.md#install-update) | <mark style="color:blue;">Update required</mark> |
| <mark style="color:blue;">Bluetooth</mark> | <mark style="color:blue;">Network Interfaces</mark> |
| [<mark style="color:green;">Bash commands</mark>](modules-settings.md#bash) | <mark style="color:blue;">Microphone used</mark> |
| [<mark style="color:green;">SystemD</mark>](modules-settings.md#systemd) | <mark style="color:blue;">Camera used</mark> |
| [<mark style="color:green;">Docker</mark>](modules-settings.md#docker) | <mark style="color:blue;">Gamepad Used</mark> |
| [<mark style="color:green;">GPIO</mark>](modules-settings.md#gpio) <mark style="color:green;">(inputs, outputs)</mark> | <mark style="color:blue;">Temperature</mark> |
| [<mark style="color:green;">IR Remote</mark>](modules-settings.md#ir-remote) | <mark style="color:blue;">WiFi</mark> |
| [<mark style="color:orange;">Keyboard Hotkeys</mark>](modules-settings.md#keyboard-hotkeys) | <mark style="color:blue;">Webcam show</mark> |
| [<mark style="color:orange;">Notify</mark>](examples.md#notification) | <mark style="color:blue;">Inference Time</mark> |
| [<mark style="color:orange;">Open URL/File</mark>](examples.md#open-a-url-or-file) <mark style="color:orange;">(xdg\_open)</mark> | [<mark style="color:green;">Statistics</mark>](examples.md#statistics) |
| [<mark style="color:orange;">Send Keys</mark>](examples.md#keys-send) | [<mark style="color:green;">Disk/Mounts usage</mark>](modules-settings.md#disk-usage) |
| <mark style="color:orange;">Mouse control</mark> | <mark style="color:orange;">Fullscreen</mark> |
| [<mark style="color:orange;">Media Controls</mark>](media-player.md) | <mark style="color:orange;">Screenshot Show</mark> |
| <mark style="color:orange;">Screen On/Off</mark> | <mark style="color:orange;">Display Variable</mark> |
| <mark style="color:orange;">Audio Select (microphone, speaker)</mark> | <mark style="color:orange;">Idle time</mark> |
| <mark style="color:orange;">Brightness</mark> | |
| <mark style="color:orange;">Keep Alive</mark> | |

## Supported OS

Expand Down
2 changes: 1 addition & 1 deletion SUMMARY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* [🖥️ Setup](setup.md)
* [📂 Configuration](configuration.md)
* [🎬 Media Player](media-player.md)
* [🔗 Settings](settings.md)
* [🔗 Modules Settings](modules-settings.md)
* [🔱 Modules Usage](examples.md)
* [🤯 Automations](automations.md)
* [🛠️ Development](development.md)
14 changes: 13 additions & 1 deletion settings.md → modules-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: User defined settings for the modules that support them
---

# 🔗 Settings
# 🔗 Modules Settings

## SystemD

Expand All @@ -15,6 +15,18 @@ settings:
- anydesk.service
```
## Docker
If no configuration is provided, then all the available docker containers will be exposed. This can be configured to only show the ones in the included list or ignore the ones in the exclude list:
```yaml
settings:
docker:
include:
- esphome
exclude: []
```
## GPIO
This is only supported by Raspberry Pi and needs to be configured manually on your _config.yaml_ file:
Expand Down
53 changes: 50 additions & 3 deletions setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
description: Get started with LNXlink
---

# 🖥 Setup
# 🖥️ Setup

## Installation

Select the installation type you want:

{% tabs %}
{% tab title="Normal" %}
{% tab title="System" %}
Install LNXlink and it's dependencies. It will create a `config.yaml` file and it will guide you through the basic configuration setup:

{% code overflow="wrap" lineNumbers="true" %}
Expand All @@ -28,6 +28,49 @@ sudo systemctl restart lnxlink.service # For root installations
{% endcode %}
{% endtab %}

{% tab title="Flatpak" %}
Install and follow the setup instructions by running it. A new configuration file will be created at `~/Documents/LNXlink/config.yaml`.&#x20;

{% code lineNumbers="true" %}
```bash
flatpak install flathub io.github.bkbilly.lnxlink
flatpak run io.github.bkbilly.lnxlink
```
{% endcode %}

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

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

{% code title="/etc/systemd/system/lnxlink.service" %}
```toml
[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
```
{% endcode %}

This must be enabled to start on boot:

{% code lineNumbers="true" %}
```bash
sudo systemctl enable lnxlink.service
sudo systemctl daemon-reload
```
{% endcode %}
{% endtab %}

{% tab title="Docker" %}
Docker is not recommended for desktop environments because it limits many modules which can't run properly. You can download LNXlink image and setup the config directory:

Expand All @@ -37,8 +80,9 @@ docker run --network host -v ~/config_lnxlink/:/opt/lnxlink/config/ -it bkbillyb
```
{% endcode %}

You can also run as a docker compose image by creating a `docker-compose.yaml` file:
You can also run as a docker compose image by creating a docker compose file:

{% code title="docker-compose.yaml" %}
```yaml
version: "3"
services:
Expand All @@ -54,6 +98,7 @@ services:
- ~/config_lnxlink/:/opt/lnxlink/config/
- /var/run/reboot-required:/var/run/reboot-required:ro
```
{% endcode %}
Run docker compose image:
Expand All @@ -79,6 +124,8 @@ lnxlink -c config.yaml
{% endtab %}
{% endtabs %}



### 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:
Expand Down

0 comments on commit 79efeb9

Please sign in to comment.