Skip to content

linux.md

Latest commit

 

History

History
102 lines (69 loc) · 1.87 KB

linux.md

File metadata and controls

102 lines (69 loc) · 1.87 KB

Linux Guide

English: docs/en/linux.md | 中文: docs/zh/linux.md

This page only covers Linux-specific differences. For the shared setup flow, see Getting Started.

Install The Binary

Download from Releases:

  • clipal-linux-amd64
  • clipal-linux-arm64

Example:

chmod +x ./clipal-linux-amd64
sudo mv ./clipal-linux-amd64 /usr/local/bin/clipal
clipal --version

Temporary Background Run

For a quick short-lived background run:

nohup clipal >/dev/null 2>&1 &

Useful for short-term use, but not the preferred long-running setup.

Long-Running Setup: systemd User Service

The recommended approach is the built-in command flow:

clipal service install
clipal service status
clipal service restart
clipal service stop
clipal service uninstall

Useful variants:

clipal service install --force
clipal service install --config-dir /path/to/config

Manual systemd Setup

If you want to manage the unit file yourself, create:

~/.config/systemd/user/clipal.service

Minimal example:

[Unit]
Description=clipal local proxy
After=network.target

[Service]
Type=simple
ExecStart=/usr/local/bin/clipal --config-dir %h/.clipal
Restart=always
RestartSec=2

[Install]
WantedBy=default.target

Enable and start it:

systemctl --user daemon-reload
systemctl --user enable --now clipal.service

Logging Advice

For long-running setups, this is a good default in config.yaml:

log_stdout: false
log_retention_days: 7

Two common log sources:

  • Clipal's own rotating logs
  • journalctl --user -u clipal.service -e

Linux-Specific Notes

  • If the port is in use, change port or override with --port
  • If the binary lives under your home directory, update ExecStart accordingly

For shared issues, continue with Troubleshooting.