Manual installation

Documentation

Advanced guides

Manual installation

Prerequisites

Before installing Jackadi, ensure you have:

A supported operating system (Linux, macOS, Windows).
Network connectivity between manager and agents.
Appropriate permissions to install binaries and create directories.

Installing binaries

From pre-built releases

Download the appropriate binaries for your platform from the releases page:

Download the latest release for your platform.
Extract the archive.
Move the binaries to a location in your PATH.

# Example for Linux amd64
tar xzf jackadi_linux_amd64.tar.gz
sudo mv manager agent jack /usr/local/bin/

Verifying installation

After installation, verify the components are working:

# Check versions
manager --version
agent --version
jack --version

# Verify help is available
jack --help

From source (advanced)

To build Jackadi from source, you need Go 1.24 or later:

# Clone the repository
git clone https://github.com/jackadi-io/jackadi.git
cd jackadi

# Build the components
make build

# Alternatively, build them individually
go build -o manager ./cmd/manager
go build -o agent ./cmd/agent
go build -o jack ./cmd/jack

Directory structure

Jackadi uses several directories for configuration, plugins, and data:

Default directories

Manager directories:

/etc/jackadi/ - Configuration files
/opt/jackadi/plugins/ - Plugin binaries
/var/lib/jackadi/ - Data and state

Agent directories:

/etc/jackadi/ - Configuration files
/var/lib/jackadi/plugins/ - Downloaded plugins
/var/log/jackadi/ - Log files

Creating directories

# Create system directories (requires sudo)
sudo mkdir -p /etc/jackadi /opt/jackadi/plugins /var/lib/jackadi
sudo mkdir -p /var/lib/jackadi/plugins /var/log/jackadi

# Set appropriate permissions
sudo chown -R jackadi:jackadi /var/lib/jackadi /var/log/jackadi
sudo chmod 755 /etc/jackadi /opt/jackadi/plugins

Setting up TLS certificates (production)

For production environments, you should use mTLS (mutual TLS) for secure communication between all components. This section provides a quick overview - see Security Setup for detailed instructions.

Quick certificate setup

Generate a CA certificate

openssl genrsa -out ca.key 4096
openssl req -new -x509 -days 365 -key ca.key -out ca.crt

Generate Manager Certificate

openssl genrsa -out manager.key 4096
openssl req -new -key manager.key -out manager.csr
openssl x509 -req -days 365 -in manager.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out manager.crt

Generate Agent Certificate

openssl genrsa -out agent.key 4096
openssl req -new -key agent.key -out agent.csr
openssl x509 -req -days 365 -in agent.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out agent.crt

Certificate distribution

After generating certificates, distribute them to appropriate systems:

# Copy certificates to manager system
sudo cp ca.crt manager.crt manager.key /etc/jackadi/certs/

# Copy certificates to agent systems
sudo cp ca.crt agent.crt agent.key /etc/jackadi/certs/

# Set proper permissions
sudo chmod 600 /etc/jackadi/certs/*.key
sudo chmod 644 /etc/jackadi/certs/*.crt

Post-installation steps

1. User and service setup

Create a dedicated user for running Jackadi services:

# Create jackadi user
sudo useradd --system --home-dir /var/lib/jackadi --shell /bin/false jackadi

# Set directory ownership
sudo chown -R jackadi:jackadi /var/lib/jackadi /var/log/jackadi

2. Systemd services (Linux)

Create systemd service files for automatic startup:

Manager service (/etc/systemd/system/jackadi-manager.service):

[Unit]
Description=Jackadi Manager
After=network.target

[Service]
Type=simple
User=jackadi
ExecStart=/usr/local/bin/manager --config /etc/jackadi/manager.yaml
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

Agent service (/etc/systemd/system/jackadi-agent.service):

[Unit]
Description=Jackadi Agent
After=network.target

[Service]
Type=simple
User=jackadi
ExecStart=/usr/local/bin/agent --config /etc/jackadi/agent.yaml
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

Enable and start services:

sudo systemctl enable jackadi-manager jackadi-agent
sudo systemctl start jackadi-manager jackadi-agent

3. Verify installation

Test basic connectivity:

# Test CLI connectivity
jack agent list

# Test basic task execution
jack run agent-name health:ping

Agent management