# FFmate

> FFmpeg Automation for the Modern Stack

Turn messy transcoding into clean, reliable workflows

## Table of Contents

### Introduction

- [FFmate: API-Powered FFmpeg automation layer for Automated Transcoding & Workflows](/docs/what-is-ffmate.md): Discover FFmate, the modern and powerful API-powered FFmpeg automation layer. Automate media workflows with its queue system, webhooks, presets & watchfolders. Simplify transcoding at scale
- [Quick Start FFmate: Install, Run Server and Core Features](/docs/getting-started.md): Your guide to getting started with FFmate. Learn to download, install, run the server, submit your first task, set up watchfolders, webhooks, and update easily

### FFmate Features

- [FFmate Task Management: Lifecycle, API, Batch & Automation](/docs/tasks.md): Detailed FFmate task documentation: Understand the complete task lifecycle, statuses, and API usage for creating, monitoring, managing, and batching FFmpeg jobs
- [Wildcards in FFmate – Dynamic File Naming and Task Scripting](/docs/wildcards.md): Learn how to use wildcards in FFmate to generate dynamic file and folder names, automate output paths, insert timestamps, and adapt processing logic based on task sources like the API or watchfolders
- [FFmate Presets: Automate & Standardize FFmpeg Workflows](/docs/presets.md): Simplify complex FFmpeg tasks with FFmate presets. Define reusable templates for commands, output paths, and processing scripts to streamline your media encoding and ensure consistency
- [Using FFmate Watchfolders for Automated FFmpeg File Processing & Transcoding](/docs/watchfolder.md): Configure FFmate watchfolders to auto-detect & transcode files. Guide to directory scanning, file growth checks, preset usage, filters & API for FFmpeg automation
- [FFmate Pre/Post-Processing: Custom Scripts, Sidecars & Workflow Automation for FFmpeg](/docs/pre-post-prcessing.md): Learn to use FFmate's pre & post-processing for FFmpeg. Run custom scripts, use JSON sidecars for task context, manage exit codes, and automate your media workflows
- [Scale FFmpeg with FFmate Clustering on PostgreSQL & Docker](/docs/clustering.md): Set up FFmate clustering with PostgreSQL to scale FFmpeg transcoding across servers. Distribute jobs, manage watchfolders, add redundancy, and boost throughput.
- [FFmate Webhooks: Real-Time Event Notifications](/docs/webhooks.md): Integrate external systems with FFmate using webhooks. Get instant notifications for task updates, batch processing, preset changes and more
- [FFmate Web UI Guide: Dashboard, Watchfolders, Presets & Logs Interface](/docs/web-ui.md): Explore the FFmate Web UI: an intuitive interface to manage FFmpeg jobs, monitor tasks, configure watchfolders, create presets, and view real-time logs

### Advanced Features

- [FFmate Architecture: Internals of API, Database, UI, Webhooks & Task Queue](/docs/ffmate-internals.md): Explore FFmate's internal architecture. Understand how its REST API, SQLite DB, Web UI, Webhooks, Watchfolders & Task Queue interact for FFmpeg automation & integration
- [FFmate Debugging Guide: CLI Flags, Environment Variables, API & Key Log Namespaces](/docs/debugging.md): Troubleshoot FFmate with this debugging guide. Control log verbosity using namespaces, command-line flags, environment variables, or dynamically via the REST API
- [Accessing FFmate's REST API Documentation via Swagger UI](/docs/swagger.md): Find FFmate's comprehensive API documentation using Swagger (OpenAPI). Get the URL to access interactive specs for all REST endpoints, models, and parameters
- [FFmate Command-Line Flags: Server, Update & Global Options](/docs/flags.md): Comprehensive guide to all FFmate command-line flags. Learn to configure FFmate's server settings (FFmpeg path, port, DB), manage updates, enable debug logs, and more

### FFmate Communnity

- [Get Help & Contribute: FFmate Support, Discord & GitHub](/docs/ffmate-community.md): Need help with FFmate or want to connect? Join our Discord community, get support, report bugs, or request features on GitHub. We'd love to hear from you!

### What's New

- [FFmate Release Notes](/docs/release-notes.md): Explore the latest FFmate release notes including new features, API changes, improvements, and bug fixes. Stay updated with every version of the open-source FFmpeg automation tool.

### Other

- [FAQ](/docs/faq.md)
- [ffmate-docs](/README.md)