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.

Get up and running with xyOps quickly using Docker. This guide walks you through installation, first login, and creating your first automated job.

​
Prerequisites

Before starting, ensure you have:
  • Docker installed and running
  • Port 5522 and 5523 available
  • Basic familiarity with shell commands

​
Install with Docker

1

Run the container

Launch xyOps with a single Docker command:
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 -v /var/run/docker.sock mount allows xyOps to manage Docker containers on your host.
2

Access the web UI

Open your browser to http://localhost:5522Default credentials:
  • Username: admin
  • Password: admin
Change the default password immediately after first login for security.
3

Create your first event

Events are jobs that run on a schedule or on demand.
  1. Click Events in the sidebar
  2. Click Add Event
  3. Set a title like “Hello World”
  4. Select Shell Plugin as the event plugin
  5. Enter this script:
#!/bin/bash
echo "Hello from xyOps!"
date
hostname
uptime
  1. Click Save Changes
4

Run your first job

  1. Click Run Now on your event
  2. Watch the live job log appear
  3. See the output from your shell script
  4. Check the Job Details page for metrics
The job runs on the local xySat worker that was automatically configured.

​
What’s next?

Self-hosting guide

Production deployment with TLS, storage backends, and multiple workers

Workflows

Build complex automation with the visual workflow editor

Monitoring

Set up server monitoring and custom metrics

API reference

Integrate xyOps with your applications

​
Common issues

If ports 5522 or 5523 are taken, change the port mapping:
-p 8080:5522 -p 8443:5523
Then access xyOps at http://localhost:8080
Check Docker logs:
docker logs xyops01
Common causes:
  • Insufficient disk space
  • Permission issues with Docker socket
  • Port conflicts
If you’ve lost your password, reset it via the command line:
docker exec -it xyops01 bin/control.sh recover
Enter your email address to reset the admin password.

​
See also

Build docs developers (and LLMs) love

Get started for freeTalk to us