Dashboard

Installation Guide

Installation Guide

This guide covers the standard installation procedures for LogFlux components from the dashboard.

Download from Dashboard

All LogFlux components are available through the LogFlux dashboard after login:

1. Access LogFlux Dashboard

  1. Go to https://dashboard.logflux.io
  2. Log in to your account

2. Navigate to Downloads

  1. Go to Downloads or Tools section
  2. Select the component you want to install:
    • LogFlux Agent - Log collection agent
    • LogFlux Inspector CLI - Command-line analysis tool
    • Grafana Datasource Plugin - Visualize logs in Grafana

3. Select Platform

Choose your operating system and architecture:

LogFlux Agent

  • macOS: Intel (amd64) and Apple Silicon (arm64)
  • Linux: x86_64 (amd64), ARM64, and various distributions
  • Windows: x86_64 (amd64) architecture

LogFlux Inspector CLI

  • macOS: Intel (darwin-amd64) and Apple Silicon (darwin-arm64)
  • Linux: x86_64 (linux-amd64) and ARM64 (linux-arm64)
  • Windows: x86_64 (windows-amd64.exe)

Grafana Datasource Plugin

  • Requires Grafana 9+ and the LogFlux API Server running locally on port 8383
  • Plugin source: clients/logflux-datasource/
  • Build: make build-client-grafana, Deploy: make deploy-client-grafana

4. Download

Click to download the installer or binary for your platform.

Platform-Specific Installation

macOS

Binary Applications (CLI)

1
2
3
4
5
6
7
8

# Make binary executable
chmod +x logflux-agent
# or
chmod +x logflux-inspector

# Move to system bin directory (optional)
sudo mv logflux-agent /usr/local/bin/
sudo mv logflux-inspector /usr/local/bin/

Grafana Plugin

1
2
3
4
5
6

# Build and deploy the Grafana plugin
make build-client-grafana
make deploy-client-grafana

# Start the LogFlux API Server
make run-client-api-server

Windows

Binary Applications (CLI)

  1. Download the .exe file
  2. Place in a directory included in your PATH
  3. Or run directly from download location

Grafana Plugin (Windows)

See Grafana plugin installation above — the same make targets work on Windows with Go and Node.js installed.

Linux

Binary Applications (CLI)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

# Make binary executable
chmod +x logflux-agent
# or  
chmod +x logflux-inspector

# Move to system bin directory
sudo mv logflux-agent /usr/local/bin/
sudo mv logflux-inspector /usr/local/bin/

# Or add to user bin directory
mkdir -p ~/.local/bin
mv logflux-agent ~/.local/bin/
mv logflux-inspector ~/.local/bin/

Grafana Plugin (Linux)

See Grafana plugin installation above — the same make targets work on Linux with Go and Node.js installed.

Verify Installation

LogFlux Agent

1
2
3
4
5

# Verify installation
logflux-agent --version

# Check agent status
logflux-agent status

LogFlux Inspector CLI

1
2
3
4
5

# Verify installation
logflux-inspector --version

# Or if not in PATH
./logflux-inspector --version

Grafana Datasource Plugin

After building and deploying with make deploy-client-grafana, restart Grafana and add LogFlux as a data source in Grafana’s configuration panel. Ensure the LogFlux API Server is running on port 8383.

System Requirements

For detailed system requirements for all LogFlux components, see System Requirements.

Quick Reference

  • RAM: 2 GB minimum (4 GB recommended)
  • Storage: 500 MB minimum (2 GB recommended)
  • OS: macOS 10.14+, Windows 10 1809+, Linux with glibc 2.17+
  • Network: Internet connection for authentication and log transmission

Security Considerations

Download Verification

  • Always download from the official LogFlux dashboard
  • Verify file checksums if provided
  • Use HTTPS connections for downloads

File Permissions

1
2
3
4
5
6
7

# Set secure permissions for binaries
chmod 755 logflux-agent
chmod 755 logflux-inspector

# Restrict access to configuration files
chmod 600 ~/.logflux/config.yaml
chmod 600 ~/.logflux/private_key.pem

Firewall Configuration

Ensure the following ports are accessible:

  • Outbound HTTPS (443): For dashboard communication
  • Local ports: As configured for agent communication

Troubleshooting Installation

Permission Issues

1
2
3
4
5
6

# macOS: Remove quarantine attribute
sudo xattr -rd com.apple.quarantine /path/to/logflux-binary

# Linux: Check execute permissions
ls -la logflux-agent
chmod +x logflux-agent

Path Issues

1
2
3
4
5
6

# Add to PATH temporarily
export PATH=$PATH:/path/to/logflux/bin

# Add to PATH permanently (.bashrc/.zshrc)
echo 'export PATH=$PATH:/usr/local/bin' >> ~/.bashrc
source ~/.bashrc

Dependency Issues

1
2
3
4
5
6
7
8
9

# Check missing libraries (Linux)
ldd logflux-agent

# Install common dependencies (Ubuntu/Debian)
sudo apt-get update
sudo apt-get install libc6 libssl1.1

# Install common dependencies (CentOS/RHEL)
sudo yum install glibc openssl-libs

Next Steps

After installation:

  1. Set up authentication with your Personal Access Token
  2. Configure the component for your specific use case
  3. Test the installation with basic commands or functionality
  4. Review component-specific documentation for detailed usage instructions

Support

If you encounter installation issues:

  • Check the troubleshooting section above
  • Review component-specific documentation
  • Contact support through the LogFlux dashboard
  • Visit logflux.io for additional resources