James Ritchie
a62cb3e60b
* Uses image cards for the frameworks
* Removes old snippets
* New AI agents side menu section
* WIP adding new ai agent pages
* Better overview page
* More copy added to the agent example pages
* Copy improvements
* Removes “Creating a project” page and side menu section
* Fixes broken links
* Updates to the latest Mintlify version, fixes issues, changes theme
* Adds descriptions to the main dropdown menu items
* Reformatted Introduction docs ‘landing page’
* Retry heartbeat timeouts by putting back in the queue (#1689)
* If there’s a heartbeat error and no attempts we put it back in the queue to try again
* When nacking, return whether it was put back in the queue or not
* Try and nack, if it fails then fail the run
* Consolidated switch statement
* Fail executing/retrying runs
* OOM retrying on larger machines (#1691)
* OOM retrying on larger machines
* Create forty-windows-shop.md
* Update forty-windows-shop.md
* Only retry again if the machine is different from the original
* Kubernetes OOMs appear as non-zero sigkills, adding support for treating these as OOMs
* Complete the original attempt span if retrying due to an OOM
* Revert "Complete the original attempt span if retrying due to an OOM"
This reverts commit 5f652c6212.
* chore: Update version for release (#1666)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Release 3.3.14
* Set machine when triggering docs
* Batch queue runs that are waiting for deploy (#1693)
* Detect ffmpeg OOM errors, added manual OutOfMemoryError (#1694)
* Detect ffmpeg OOM errors, added manual OutOfMemoryError
* Create eighty-spies-knock.md
* Improved the machines docs, including the new OutOfMemoryError
* chore: Update version for release (#1695)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Release 3.3.15
* Create new partitioned TaskEvent table, and switch to it gradually as new runs are created (#1696)
* Create new partitioned TaskEvent table, and switch to it gradually as new runs are created
* Add env var for partition window in seconds
* Make startCreatedAt required in task event store
* Don't create an attempt if the run is final, batchTriggerAndWait bad continue fix (#1698)
* WIP fix for ResumeAttemptService selecting the wrong attempt (which has no error or output)
* Don’t create an attempt if the run is already in a final status
* Don’t get all the columns for the query. Improved the logging.
* Added a log to the batch example
* Filter out the undefined values
* Fix missing logs on child runs by using the root task run createdAt if it exists (#1697)
* Provider changes to support image cache (#1700)
* add env var for additional pull secrets
* make static images configurable
* optional image prefixes
* optional labels with sample rates
* add missing core paths
* remove excessive logs
* Fix run container exits after OOM retries (#1701)
* remove unused imports
* tell run to exit before force requeue
* handle exit for case where we already retried after oom
* improve retry span and add machine props
* don't try to exit run in dev
* Upgrade local dev to use electric beta.15 (#1699)
* Text fixes
* Removed pnpm files
---------
Co-authored-by: Matt Aitken <matt@mattaitken.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Eric Allam <eric@trigger.dev>
Co-authored-by: nicktrn <55853254+nicktrn@users.noreply.github.com>
133 lines
6.3 KiB
Plaintext
133 lines
6.3 KiB
Plaintext
---
|
|
title: "Welcome to the Trigger.dev docs"
|
|
sidebarTitle: "Introduction"
|
|
description: "Find all the resources and guides you need to get started"
|
|
mode: "center"
|
|
---
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Quick start" img="/images/intro-quickstart.jpg" href="/quick-start">
|
|
Get started with Trigger.dev in 3 minutes
|
|
</Card>
|
|
<Card title="Examples" img="/images/intro-examples.jpg" href="/guides/introduction#example-tasks">
|
|
Explore dozens of examples tasks to use in your own projects
|
|
</Card>
|
|
<Card title="Frameworks" img="/images/intro-frameworks.jpg" href="/guides/introduction#frameworks">
|
|
Learn how to use Trigger.dev with your favorite frameworks
|
|
</Card>
|
|
<Card title="Video walkthrough" img="/images/intro-video.jpg" href="/video-walkthrough">
|
|
Watch an end-to-end demo of Trigger.dev in 10 minutes
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## What is Trigger.dev?
|
|
|
|
Trigger.dev is an open source background jobs framework that lets you write reliable workflows in plain async code. Run long-running AI tasks, handle complex background jobs, and build AI agents with built-in queuing, automatic retries, and real-time monitoring. No timeouts, elastic scaling, and zero infrastructure management required.
|
|
|
|
We provide everything you need to build and manage background tasks: a [CLI and SDK](/config/config-file) for writing tasks in your existing codebase, support for both [regular](/tasks-regular) and [scheduled](/tasks/scheduled) tasks, full observability through our dashboard, and a [Realtime API](/realtime) with [React hooks](/frontend/react-hooks#realtime-hooks) for showing task status in your frontend. You can use [Trigger.dev Cloud](https://cloud.trigger.dev) or [self-host](/open-source-self-hosting) on your own infrastructure.
|
|
|
|
## Learn the concepts
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Writing tasks" icon="wand-magic-sparkles" href="/tasks/overview" color="#3B82F6">
|
|
Tasks are the core of Trigger.dev. Learn what they are and how to write them.
|
|
</Card>
|
|
<Card title="Triggering tasks" icon="bullseye-pointer" href="/triggering" color="#fbbf24">
|
|
Learn how to trigger tasks from your codebase.
|
|
</Card>
|
|
<Card title="Runs" icon="person-running" href="/runs" color="#EA189E">
|
|
Runs are the instances of tasks that are executed. Learn how they work.
|
|
</Card>
|
|
<Card title="API keys" icon="key" href="/apikeys" color="#EAEA08">
|
|
API keys are used to authenticate requests to the Trigger.dev API. Learn how to create and use them.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Explore by feature
|
|
|
|
<CardGroup>
|
|
<Card title="Scheduled tasks (cron)" icon="clock" href="/tasks/scheduled" color="#EAEA08">
|
|
Scheduled tasks are a type of task that is scheduled to run at a specific time.
|
|
</Card>
|
|
<Card title="Realtime API" icon="loader" href="/realtime" color="#22C55E">
|
|
The Realtime API allows you to trigger tasks and get the status of runs.
|
|
</Card>
|
|
<Card title="React hooks" icon="react" href="/frontend/react-hooks" color="#3B82F6">
|
|
React hooks are a way to show task status in your frontend.
|
|
</Card>
|
|
<Card title="Waits" icon="calendar-clock" href="/wait" color="#F59E0B">
|
|
Waits are a way to wait for a task to finish before continuing.
|
|
</Card>
|
|
<Card title="Errors and retries" icon="message-exclamation" href="/errors-retrying" color="#F43F5E">
|
|
Learn how to handle errors and retries.
|
|
</Card>
|
|
<Card title="Concurrency & Queues" icon="line-height" href="/queue-concurrency" color="#D946EF">
|
|
Configure what you want to happen when there is more than one run at a time.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Explore by example
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="FFmpeg" img="/images/intro-ffmpeg.jpg" href="/guides/examples/ffmpeg-video-processing"/>
|
|
<Card title="Fal.ai" img="/images/intro-fal.jpg" href="/guides/examples/fal-ai-image-to-cartoon"/>
|
|
<Card title="Puppeteer" img="/images/intro-puppeteer.jpg" href="/guides/examples/puppeteer"/>
|
|
<Card title="LibreOffice" img="/images/intro-libreoffice.jpg" href="/guides/examples/libreoffice-pdf-conversion"/>
|
|
<Card title="OpenAI" img="/images/intro-openai.jpg" href="/guides/examples/open-ai-with-retrying"/>
|
|
<Card title="Browserbase" img="/images/intro-browserbase.jpg" href="/guides/examples/scrape-hacker-news"/>
|
|
<Card title="Sentry" img="/images/intro-sentry.jpg" href="/guides/examples/sentry-error-tracking"/>
|
|
<Card title="Resend" img="/images/intro-resend.jpg" href="/guides/examples/resend-email-sequence"/>
|
|
<Card title="Vercel AI SDK" img="/images/intro-vercel.jpg" href="/guides/examples/vercel-ai-sdk"/>
|
|
<Card title="Sharp" img="/images/intro-sharp.jpg" href="/guides/examples/sharp-image-processing"/>
|
|
<Card title="Deepgram" img="/images/intro-deepgram.jpg" href="/guides/examples/deepgram-transcribe-audio"/>
|
|
<Card title="Supabase" img="/images/intro-supabase.jpg" href="/guides/examples/supabase-database-operations"/>
|
|
<Card title="DALL•E" img="/images/intro-openai.jpg" href="/guides/examples/dall-e3-generate-image"/>
|
|
<Card title="Firecrawl" img="/images/intro-firecrawl.jpg" href="/guides/examples/firecrawl-url-crawl"/>
|
|
</CardGroup>
|
|
|
|
|
|
## Getting help
|
|
|
|
We'd love to hear from you or give you a hand getting started. Here are some ways to get in touch with us.
|
|
|
|
<CardGroup>
|
|
<Card
|
|
title="Join our Discord server"
|
|
icon="discord"
|
|
href="https://discord.gg/kA47vcd8P6"
|
|
color="#5865F2"
|
|
>
|
|
Our Discord is the best place to get help with any questions about Trigger.dev.
|
|
</Card>
|
|
<Card
|
|
title="Follow us on X (Twitter)"
|
|
icon={
|
|
<svg xmlns="http://www.w3.org/2000/svg" height="20" viewBox="0 0 512 512">
|
|
<path d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8L200.7 275.5 26.8 48H172.4L272.9 180.9 389.2 48zM364.4 421.8h39.1L151.1 88h-42L364.4 421.8z" />
|
|
</svg>
|
|
}
|
|
href="https://twitter.com/triggerdotdev"
|
|
color="#1DA1F2"
|
|
>
|
|
Follow us to get the latest updates and news.
|
|
</Card>
|
|
<Card
|
|
title="Schedule a call"
|
|
icon="phone"
|
|
iconType="solid"
|
|
color="#22C55E"
|
|
href="https://cal.com/team/triggerdotdev/founders-call"
|
|
>
|
|
Arrange a call with one of the founders to get help with any questions.
|
|
</Card>
|
|
<Card
|
|
title="Give us a star on GitHub"
|
|
icon="star"
|
|
iconType="solid"
|
|
href="https://github.com/triggerdotdev/trigger.dev"
|
|
color="#fbbf24"
|
|
>
|
|
Check us out our GitHub repo and give us a star if you like what we're doing.
|
|
</Card>
|
|
</CardGroup>
|