Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pixlcore/xyops/llms.txt

Use this file to discover all available pages before exploring further.

Workflow Automation & Server Monitoring

Schedule jobs, orchestrate workflows, monitor servers, and respond to incidents—all in a single, cohesive platform. Built for developers and operations teams who value control and visibility.

Get StartedExplore API

Quick start

Get up and running with xyOps in minutes

1

Launch xyOps

Run xyOps locally with Docker. This command starts the platform with default settings and creates a local administrator account.
Docker
docker run --detach --init --restart unless-stopped \
  -v xy-data:/opt/xyops/data \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e TZ="America/Los_Angeles" \
  -e XYOPS_xysat_local="true" \
  -p 5522:5522 -p 5523:5523 \
  --name "xyops01" --hostname "xyops01" \
  ghcr.io/pixlcore/xyops:latest
The platform will be available at http://localhost:5522. Default credentials are admin / admin.
2

Create your first event

Events are the foundation of xyOps—they define what to run, where, and when. Log in to the web UI and navigate to the Events tab to create a new event with a simple shell command.
Shell Script
#!/bin/bash
echo "Hello from xyOps!"
date
hostname
Set a schedule or trigger it manually to see your first job execute.
3

Monitor your servers

xyOps automatically collects metrics from all connected servers. Navigate to Servers to view real-time CPU, memory, disk, and network usage. Create custom monitors and alerts to track what matters to your infrastructure.
// Alert when CPU load exceeds 2.0 for 5 minutes
cpu.avgLoad > 2.0
4

Build a workflow

Use the visual workflow editor to orchestrate complex multi-step processes. Workflows let you chain events, handle errors, and implement conditional logic—all through a graphical interface.Check out Workflows to learn about nodes, connections, and control flow.

Core features

Everything you need to automate and monitor your infrastructure

Job scheduling

Schedule jobs with cron syntax, intervals, single-shot timers, and blackout windows. Control concurrency and retries.

Visual workflows

Build complex automation with a graphical editor. Chain jobs, implement conditional logic, and handle errors.

Server monitoring

Collect metrics from your fleet. Define custom monitors with expression-based queries and time-series graphs.

Smart alerting

Set up alerts that trigger on complex conditions. Send notifications, open tickets, or run remediation jobs.

Incident tickets

Integrated ticketing system for incident response. Link tickets to jobs, alerts, and server snapshots.

Plugin marketplace

Extend xyOps with plugins in any language. Discover and install community plugins from the marketplace.

Secrets management

Store sensitive credentials securely. Inject secrets into jobs and plugins at runtime.

Distributed architecture

Deploy satellite workers across your infrastructure. Built for Docker with automatic failover.

Explore by topic

Dive deeper into specific areas

Configuration

Configure xyOps for production with storage backends, TLS, logging, and environment variables.

Scaling

Best practices for running at scale. Hardware sizing, caching, and multi-conductor setup.

CLI tools

Command-line utilities for service control, database management, and admin operations.

Expressions

Learn the xyOps expression language for monitors, alerts, and conditional logic.

Data formats

Documentation for xyOps data interchange formats including XYPDF, XYBK, and XYWP.

Recipes

Practical patterns and examples for common automation scenarios.

Resources

Additional help and information

GitHub repository

Browse the source code, report issues, and contribute to the project.

View on GitHub

Migration guide

Migrating from Cronicle? Learn how to import your existing jobs and configuration.

Read the guide

Ready to automate your infrastructure?

Get started with xyOps today. Deploy with Docker, configure your first jobs, and start monitoring your fleet in minutes.

Start building