Home - contribsys/faktory GitHub Wiki

Faktory is a language-agnostic, persistent background job system.

Getting Started?

• Getting Started Ruby - processing Faktory jobs using Ruby
• Getting Started Golang - using Go workers with Faktory
• Getting Started Python - using Python with Faktory
• Getting Started Python - using Python with Faktory
• Want to use Rust, JavaScript, PHP, Elixir, etc? Go here

Documentation

• Installation - how to install Faktory
• The Job Payload - the job payload is the core data structure for Faktory
• Job Errors - how Faktory helps you handle job errors
• Security - how to secure Faktory
• Related Projects - worker libraries and other Faktory-related projects
• Development - it's open source, interested in working on the Faktory codebase itself?
• Worker Lifecycle - how to implement a worker package
• Mutate API - the Mutate API allows you to clean out bad jobs from Faktory
• Debugging - having problems with Faktory itself?
• Storage - learn about Redis storage
• Kubernetes - how to run Faktory with Kubernetes
• AWS ECS - how to run Faktory in AWS ECS
• Docker - how to run Faktory via Docker

Faktory Enterprise

Upgrade to Faktory Enterprise for more features and official support.

• Purchase Faktory Enterprise
• Ent Cron - enqueue jobs periodically
• Ent Metrics - send real-time usage metrics to Statsd for monitoring
• Ent Redis Gateway - expose Faktory's Redis instance to the network
• Ent Expiring Jobs - expire jobs after a time period
• Ent Unique Jobs - ensure jobs aren't duplicated for a time
• Ent Installation - how to install Faktory Enterprise
• Ent Throttling - throttle queues to prevent worker overload or SLA violations
• Ent Batches - create complex asynchronous job workflows
• Ent Tracking - track job execution progress
• Ent Remote Redis - use a remote Redis instance with Faktory

Commercial Info

• Licensing - learn how Faktory Enterprise licensing works