Shipherd
THIS IS JUST A PREVIEW LAUNCH PAGE — I HAVEN'T PUBLISHED SHIPHERD YET

A sleek Docker container that provides a web-based GUI for running and managing your code on a home server. No more manual script execution.

🚀 Get Started 📦 View on GitHub

Why Choose Shipherd?

Transform your home server into a powerful project management hub with intuitive controls and robust monitoring.

Project Management

Project Management

Organize and run multiple projects from a single dashboard. Support for Python, Node.js, and more with automatic dependency management.

Smart Auto-Restart

Smart Auto-Restart

Configurable crash recovery, file change detection, and scheduled restarts. Keep your projects running smoothly without manual intervention.

Persistent Data Protection

Persistent Data Protection

Your data stays safe in protected directories that survive code updates and GitHub syncs. Never lose important project data again.

Real-time Monitoring

Real-time Monitoring

Live logs, searchable history, and webhook alerts. Stay informed about your projects' health with comprehensive monitoring tools.

GitHub Integration

GitHub Integration

Sync your projects directly from GitHub repositories. Automatic updates while preserving your persistent data and configurations.

Secure & Isolated

Secure & Isolated

Admin authentication, project isolation, and future-ready user role support. Built with security and scalability in mind.

Installation

Get Shipherd running on your platform in minutes. Choose your preferred deployment method below.

Docker Compose (Recommended)

Create a docker-compose.yml file:

services:
  shipherd:
    image: marvilco/shipherd:latest
    container_name: shipherd
    ports:
      - "4943:4943"
    volumes:
      - ./data:/app/data:rw
    environment:
      - TZ=America/New_York
      - LOG_FORMAT=pretty # or json
    restart: unless-stopped

Then run:

docker-compose up -d

Docker Run

Run Shipherd with a single Docker command:

docker run -d \
  --name shipherd \
  -p 4943:4943 \
  -v ./data:/app/data:rw \
  -e TZ=America/New_York \
  -e LOG_FORMAT=pretty \
  --restart unless-stopped \
  marvilco/shipherd:latest

UnRAID Installation

Install Shipherd from the UnRAID Community Applications:

  1. Go to Apps in your UnRAID dashboard
  2. Search for "Shipherd"
  3. Click Install on the Shipherd app by the user marvil
  4. Configure the following settings:
    • Port: 4943 (or your preferred port)
    • Data Path: /mnt/user/[your-share]/shipherd
  5. Click Apply

📚 Need Help?

Check out our comprehensive documentation for detailed setup guides, configuration options, and troubleshooting tips.

View Documentation