Installation Guide

Recommended: Docker Compose

  1. Install Docker and Docker Compose.
  2. Download the compose file.
curl -O https://raw.githubusercontent.com/jincaiw/logcat/v0.2.0/docker-compose.yml

Optional: edit docker-compose.yml and set a strong initial admin password before the first start.

environment:
  LOGCAT_ADMIN_PASSWORD: change-me-now

Start logcat:

docker compose up -d

Open http://<server-ip>:8080. Default account: admin / admin123 if no custom password was set.

One-line Linux install

curl -fsSL https://raw.githubusercontent.com/jincaiw/logcat/v0.2.0/scripts/install-linux.sh | sudo bash

The installer downloads the binary package, installs it to /opt/logcat, creates a systemd service, and starts it automatically.

systemctl status logcat
journalctl -u logcat -f

Binary package

tar -xzf logcat-0.2.0-linux-amd64.tar.gz
cd logcat-0.2.0-linux-amd64
./start.sh 8080

Ports

PortProtocolDescription
8080TCPWeb UI and API
5140UDP/TCPSyslog receiver

Environment variables

VariableDescription
SYSLG_ALERT_DATA_DIRData directory
SYSLG_ALERT_TEMPLATES_DIRTemplate directory
LOGCAT_OPEN_BROWSERSet 1 to open browser automatically
LOGCAT_ADMIN_USERNAMEInitial admin username
LOGCAT_ADMIN_PASSWORDInitial admin password

Upgrade

docker compose pull
docker compose up -d

For systemd installation:

curl -fsSL https://raw.githubusercontent.com/jincaiw/logcat/v0.2.0/scripts/install-linux.sh | sudo VERSION=0.2.0 bash