Launching the Server
This page covers starting the Konarr server and verifying it's running correctly. For comprehensive web interface usage, see the Web Interface Guide.
Starting the Server
Using Docker (Recommended)
# Using Docker
docker run -d \
--name konarr-server \
-p 9000:9000 \
-v $(pwd)/data:/data \
ghcr.io/42bytelabs/konarr:latest
# Using Docker Compose
docker-compose up -d konarr-server
Using Pre-built Binary
# Download and extract binary
curl -L https://github.com/42ByteLabs/konarr/releases/latest/download/konarr-server-linux-x86_64.tar.gz | tar xz
# Run server
./konarr-server
From Source
# Build and run from source
git clone https://github.com/42ByteLabs/konarr.git
cd konarr
cargo run --bin konarr-server
Verifying Server Status
Health Check
Test that the server is running and accessible:
# Basic health check
curl -v http://localhost:9000/api/health
# Expected response:
# HTTP/1.1 200 OK
# {"status":"healthy","version":"x.x.x"}
Server Logs
Monitor server startup and operation:
# Docker logs
docker logs -f konarr-server
# Binary logs (with RUST_LOG=info)
RUST_LOG=info ./konarr-server
Initial Access
Web Interface
Open the server URL in your browser (default port 9000):
http://localhost:9000
First-Time Setup
- Web Interface: Navigate to the web interface to verify it loads correctly
- Admin Account: Create or configure admin access if required
- Agent Token: Retrieve the auto-generated agent token for agent setup
For detailed web interface usage, navigation, and features, see the Web Interface Guide.
Configuration
Basic Configuration
Create a konarr.yml
file for persistent settings:
server:
domain: "localhost"
port: 9000
scheme: "http"
data_path: "/data"
Environment Variables
Override configuration with environment variables:
export KONARR_SERVER_PORT=8080
export KONARR_DATA_PATH=/custom/data/path
./konarr-server
For complete configuration options, see:
Next Steps
After launching the server:
- Web Interface - Learn to use the web interface
- Agent Setup - Configure agents to monitor containers
- Security Setup - Implement production security practices
- Reverse Proxy - Set up HTTPS and production deployment