Fixed typo in Run iSponsorBlockTV in PyPi section and included basic tutorial on creating and running isponsorblocktv as a background service

Edward Dong
2026-01-08 08:45:20 -07:00
parent e52f2c589a
commit d05fdde67d

@@ -142,16 +142,90 @@ This is a great option if you experience issues with the graphical configurator.
isponsorblocktv --setup-cli
```
## Run iSponsorBlockTV
## Run iSponsorBlockTV and Service setup for uv/pipx installers
After installing iSponsorBlockTV, you can run it using the following command:
```Shell
isponsorblocktv
iSponsorBlockTV
```
You should create a service using systemd, or another service manager, to run iSponsorBlockTV in the background. There's [an open issue](https://github.com/dmunozv04/iSponsorBlockTV/issues/108) to handle this automatically.
Debian 13 example (installed using pipx or uv):
### 1. Creating service file (isponsorblocktv.service)
```Shell
sudo nano /etc/systemd/system/isponsorblocktv.service
```
### 2. Turning it into a service
```Shell
[Unit]
Description=isponsorblocktv background service
# Start after basic system initialization and networking are available
After=network.target multi-user.target
[Service]
Type=simple
# Path to your shell script (check your path with: which iSponsorBlockTV)
ExecStart=/home/pi/.local/bin/iSponsorBlockTV
# Ensure the service restarts if it fails
Restart=on-failure
# Wait 10 second before attempting a restart
RestartSec=10
# Optional: specify a user to run the service as (defaults to root if none specified, my user is called pi)
User=pi
StandardOutput=journal
[Install]
# Enable the service to start automatically at boot
WantedBy=multi-user.target
```
After pasting, you want to press CTRL+O (not zero) to write out/save the file
Enter/Return to confirm write
and CTRL+X to exit nano/text editor
### 3. Start and enable the service
Reload daemon
```Shell
systemctl daemon-reload
```
Start the service, this starts it for the first time
```Shell
systemctl start isponsorblocktv.service
```
Enable the service, this makes it run on boot after networking is ready
```Shell
systemctl enable isponsorblocktv.service
```
Check the service
```Shell
systemctl status isponsorblocktv.service
```
If everything went well you should see something like:
```Shell
pi@pi:/etc/systemd/system $ systemctl status isponsorblock.service
● isponsorblocktv.service - isponsorblocktv background service
Loaded: loaded (/etc/systemd/system/isponsorblock.service; enabled; preset: enabled)
Active: active (running) since Thu 2026-01-08 00:06:09 MST; 8h ago
Invocation: a68e17cbb6da43318f07b23d54fa1775
Main PID: 7266 (iSponsorBlockTV)
Tasks: 3 (limit: 163)
CPU: 53.884s
CGroup: /system.slice/isponsorblock.service
└─7266 /home/pi/.local/share/uv/tools/isponsorblocktv/bin/python /home/pi/.local/bin/iSponsorBlockTV
Jan 08 08:20:17 pi iSponsorBlockTV[7266]: 2026-01-08 08:20:17,000 - iSponsorBlockTV-ppmi1vccl8tsfbpl5j347h2oj5 - INFO ->
Jan 08 08:24:52 pi iSponsorBlockTV[7266]: 2026-01-08 08:24:52,629 - iSponsorBlockTV-ppmi1vccl8tsfbpl5j347h2oj5 - INFO ->
```
# From Releases
You can download the latest release from the [releases page](https://github.com/dmunozv04/iSponsorBlockTV/releases/latest).