Systemd Service Installation

This directory contains a systemd service file for running invidious-companion as a system service.

Prerequisites

Create a dedicated user and group:

sudo useradd -r -s /bin/false invidious

Create necessary directories:

sudo mkdir -p /home/invidious/invidious-companion
sudo mkdir -p /home/invidious/tmp
sudo mkdir -p /var/tmp/youtubei.js
sudo chown -R invidious:invidious /home/invidious
sudo chown invidious:invidious /var/tmp/youtubei.js

Installation

Compile the invidious-companion binary:

deno task compile

Copy the binary to the service directory:

sudo cp invidious_companion /home/invidious/invidious-companion/
sudo chown invidious:invidious /home/invidious/invidious-companion/invidious_companion
sudo chmod +x /home/invidious/invidious-companion/invidious_companion

Copy configuration if needed:

# Copy your config.toml to /home/invidious/invidious-companion/config/config.toml
# Or use environment variables in the service file

Install the systemd service:

sudo cp invidious-companion.service /etc/systemd/system/
sudo systemctl daemon-reload

Enable and start the service:

sudo systemctl enable invidious-companion.service
sudo systemctl start invidious-companion.service

Configuration

The service is configured to:

Run as the invidious user for security
Use a Unix domain socket at /home/invidious/tmp/invidious-companion.sock
Cache YouTube data in /var/tmp/youtubei.js
Apply strict security restrictions similar to inv_sig_helper

You can modify the environment variables in the service file or use a configuration file.

Monitoring

Check service status:

sudo systemctl status invidious-companion.service

View logs:

sudo journalctl -u invidious-companion.service -f