# yaml-language-server: $schema=https://schema.zeabur.app/template.json
apiVersion: zeabur.com/v1
kind: Template
metadata:
    name: Firecrawl
spec:
    description: Open-source web crawler and scraper API for AI applications, knowledge bases, and data pipelines.
    icon: https://cdn-console.zeabur.com/f/xrty/firecrawl_logo-removebg-preview.png
    variables:
        - key: PUBLIC_DOMAIN
          type: DOMAIN
          name: Domain
          description: Domain for the Firecrawl API endpoint.
        - key: OPENAI_API_KEY
          type: STRING
          name: OpenAI API Key (Optional)
          description: Optional. Enables Firecrawl's LLM extract feature. Your OpenAI-compatible provider key.
        - key: OPENAI_BASE_URL
          type: STRING
          name: OpenAI Base URL (Optional)
          description: OpenAI-compatible endpoint, e.g. https://api.openai.com/v1 (defaults to OpenAI if blank)
    tags:
        - Crawler
        - AI
        - Web
    readme: "# Firecrawl\n\n\U0001F680 [Firecrawl](https://github.com/firecrawl/firecrawl) is an open-source web crawler and scraper API for AI applications, knowledge bases, and data pipelines.\n\nThis template deploys the full self-hosted Firecrawl stack:\n\n- **api** — main Firecrawl process. Runs `harness.js --start-docker`, which manages the API server plus worker, extract-worker, and several NUQ queue worker subprocesses inside the same container.\n- **playwright** — browser automation microservice for JS-rendered pages.\n- **redis** — cache and rate-limit store.\n- **rabbitmq** — broker for the NUQ task queue.\n- **postgres** — Postgres 17 + pg_cron, pre-loaded with the NUQ queue schema.\n\n## Resource recommendation\n\nFirecrawl is resource-intensive. The upstream `docker-compose.yaml` recommends **at least 4 vCPU / 8 GB RAM** for the `api` service and **2 vCPU / 4 GB RAM** for `playwright`. We recommend deploying this template on a Pro plan or a dedicated server.\n\n## Configuration\n\nOnly the public domain is required. Core scraping and crawling work with no LLM configured.\n\n**LLM extract (optional, bring your own OpenAI-compatible provider):** the deploy form offers two optional fields — **OpenAI API Key** and **OpenAI Base URL**. Fill in your provider key to enable Firecrawl's LLM-powered features (llm-extract, summary, `/v2/extract`, `/v2/agent`). Leave both blank to deploy without LLM.\n\n- **OpenAI direct:** set `OPENAI_API_KEY` and leave `OPENAI_BASE_URL` blank — Firecrawl falls back to the OpenAI default endpoint.\n- **Other OpenAI-compatible providers (OpenRouter, xAI, Ollama, a self-hosted gateway, …):** set both `OPENAI_API_KEY` and `OPENAI_BASE_URL` (e.g. `https://openrouter.ai/api/v1`). You can also set `MODEL_NAME` on the api service env tab. The full list of supported variables lives in [`apps/api/src/config.ts`](https://github.com/firecrawl/firecrawl/blob/main/apps/api/src/config.ts).\n\nYou can change these any time on the api service env tab and restart the service.\n\n**Caveats:**\n- Some OpenAI-compatible providers do not expose embedding models. When embeddings are unavailable, crawl link relevance ranking falls back to no-ranking — the rest of the LLM features (extract, agent, summary) are unaffected.\n- A few Firecrawl features (interactive browser-agent, direct-quote handling) call Google Gemini directly via `@ai-sdk/google` rather than through `OPENAI_BASE_URL`. To enable them, also set `GOOGLE_GENERATIVE_AI_API_KEY` on the api service.\n\n`BULL_AUTH_KEY` (which protects the internal Bull queue dashboard) is auto-generated; you can find it on the api service env tab.\n\nAuthentication is **disabled** by default (`USE_DB_AUTHENTICATION=false`). The API endpoint is public — protect your domain with Cloudflare, an auth proxy, or a network ACL if exposed to the internet.\n\n## Quick test\n\nAfter deployment finishes, hit the scrape endpoint:\n\n```bash\ncurl -X POST https://<your-domain>/v1/scrape \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"url\": \"https://docs.firecrawl.dev\"}'\n```\n\n## Queue dashboard\n\nFirecrawl has no end-user UI — it is an API-only service. For operators, a built-in [Bull Dashboard](https://github.com/felixmosh/bull-board) is mounted at:\n\n```\nhttps://<your-domain>/admin/<BULL_AUTH_KEY>/queues\n```\n\nUse it to monitor queue throughput, inspect active / completed / failed jobs, and replay errors. Find your `BULL_AUTH_KEY` on the **api** service env tab.\n\n## Versioning\n\nFirecrawl upstream does not publish semver tags — only `:latest`, which is rebuilt every time `main` advances. To give you reproducible deploys, this template pins each image by digest (`@sha256:...`). The current pin corresponds to the build of **2026-05-04**. Updates ship as new template revisions.\n\n## Reference\n\n- GitHub: https://github.com/firecrawl/firecrawl\n- Docs: https://docs.firecrawl.dev/\n- License: AGPL-3.0"
    services:
        - name: postgres
          icon: https://cdn.zeabur.com/marketplace/postgresql.svg
          template: PREBUILT
          spec:
            id: postgres
            source:
                image: ghcr.io/firecrawl/nuq-postgres@sha256:f9388bd25ae2e1f1d034518236f993ce236173c1d8800ce24092ea6643a95a33
            ports:
                - id: database
                  port: 5432
                  type: TCP
            volumes:
                - id: data
                  dir: /var/lib/postgresql/data
            env:
                POSTGRES_DB:
                    default: postgres
                    expose: true
                POSTGRES_HOST:
                    default: ${CONTAINER_HOSTNAME}
                    expose: true
                POSTGRES_PASSWORD:
                    default: ${PASSWORD}
                    expose: true
                POSTGRES_PORT:
                    default: ${DATABASE_PORT}
                    expose: true
                POSTGRES_USER:
                    default: postgres
                    expose: true
            healthCheck:
                type: TCP
                port: database
        - name: redis
          icon: https://raw.githubusercontent.com/zeabur/service-icons/main/marketplace/redis.svg
          template: PREBUILT
          spec:
            id: redis
            source:
                image: redis:7-alpine
                command:
                    - redis-server
                    - --bind
                    - 0.0.0.0
            ports:
                - id: database
                  port: 6379
                  type: TCP
            volumes:
                - id: data
                  dir: /data
            env:
                REDIS_HOST:
                    default: ${CONTAINER_HOSTNAME}
                    expose: true
                REDIS_PORT:
                    default: ${DATABASE_PORT}
                    expose: true
                REDIS_URL:
                    default: redis://${REDIS_HOST}:${REDIS_PORT}
                    expose: true
            healthCheck:
                type: TCP
                port: database
        - name: rabbitmq
          icon: https://raw.githubusercontent.com/zeabur/service-icons/main/marketplace/rabbitmq.svg
          template: PREBUILT
          spec:
            id: rabbitmq
            source:
                image: rabbitmq:3-management
            ports:
                - id: amqp
                  port: 5672
                  type: TCP
            volumes:
                - id: data
                  dir: /var/lib/rabbitmq
            env:
                NUQ_RABBITMQ_URL:
                    default: amqp://${RABBITMQ_DEFAULT_USER}:${RABBITMQ_DEFAULT_PASS}@${RABBITMQ_HOST}:${RABBITMQ_PORT}
                    expose: true
                RABBITMQ_DEFAULT_PASS:
                    default: ${PASSWORD}
                    expose: true
                RABBITMQ_DEFAULT_USER:
                    default: firecrawl
                    expose: true
                RABBITMQ_HOST:
                    default: ${CONTAINER_HOSTNAME}
                    expose: true
                RABBITMQ_PORT:
                    default: ${AMQP_PORT}
                    expose: true
            healthCheck:
                type: TCP
                port: amqp
        - name: playwright
          icon: https://raw.githubusercontent.com/github/explore/60cd2530141f67f07a947fa2d310c482e287e387/topics/playwright/playwright.png
          template: PREBUILT
          spec:
            id: playwright
            source:
                image: ghcr.io/firecrawl/playwright-service@sha256:9e0737bc09df28275aab29726b1c0824a7725113945434e843385d487b7f7ec6
            ports:
                - id: web
                  port: 3000
                  type: TCP
            env:
                BLOCK_MEDIA:
                    default: "false"
                MAX_CONCURRENT_PAGES:
                    default: "10"
                PLAYWRIGHT_HOST:
                    default: ${CONTAINER_HOSTNAME}
                    expose: true
                PLAYWRIGHT_MICROSERVICE_URL:
                    default: http://${PLAYWRIGHT_HOST}:${PLAYWRIGHT_PORT}/scrape
                    expose: true
                PLAYWRIGHT_PORT:
                    default: ${WEB_PORT}
                    expose: true
                PORT:
                    default: "3000"
            healthCheck:
                type: TCP
                port: web
        - name: api
          icon: https://cdn-console.zeabur.com/f/xrty/firecrawl_logo-removebg-preview.png
          dependencies:
            - postgres
            - redis
            - rabbitmq
            - playwright
          template: PREBUILT
          spec:
            id: api
            source:
                image: ghcr.io/firecrawl/firecrawl@sha256:3ad8dfb4a4826a187a90a6154c1e9ec253f7dad55756172e094e66df32d75586
                command:
                    - /bin/sh
                    - -c
                    - |
                      exec node dist/src/harness.js --start-docker
            ports:
                - id: web
                  port: 3002
                  type: HTTP
            instructions:
                - title: Firecrawl API URL
                  content: https://${ZEABUR_WEB_DOMAIN}
                - title: Bull Queue Dashboard
                  content: https://${ZEABUR_WEB_DOMAIN}/admin/${BULL_AUTH_KEY}/queues
                - title: Quick scrape (curl)
                  content: |-
                    curl -X POST https://${ZEABUR_WEB_DOMAIN}/v1/scrape \
                      -H 'Content-Type: application/json' \
                      -d '{"url":"https://docs.firecrawl.dev"}'
            env:
                BROWSER_POOL_SIZE:
                    default: "5"
                BULL_AUTH_KEY:
                    default: ${PASSWORD}
                CRAWL_CONCURRENT_REQUESTS:
                    default: "10"
                ENV:
                    default: local
                HARNESS_STARTUP_TIMEOUT_MS:
                    default: "120000"
                HOST:
                    default: 0.0.0.0
                INTERNAL_PORT:
                    default: ${WEB_PORT}
                LOGGING_LEVEL:
                    default: info
                MAX_CONCURRENT_JOBS:
                    default: "5"
                NUM_WORKERS_PER_QUEUE:
                    default: "8"
                OPENAI_API_KEY:
                    default: ${OPENAI_API_KEY}
                OPENAI_BASE_URL:
                    default: ${OPENAI_BASE_URL}
                PORT:
                    default: ${WEB_PORT}
                REDIS_RATE_LIMIT_URL:
                    default: ${REDIS_URL}
                USE_DB_AUTHENTICATION:
                    default: "false"
            healthCheck:
                type: TCP
                port: web
          domainKey: PUBLIC_DOMAIN
localization:
    es-ES:
        description: API de rastreo y extracción web de código abierto para aplicaciones de IA, bases de conocimiento y pipelines de datos.
        readme: "# Firecrawl\n\n\U0001F680 [Firecrawl](https://github.com/firecrawl/firecrawl) es una API de rastreo y extracción web de código abierto para aplicaciones de IA, bases de conocimiento y pipelines de datos.\n\nEsta plantilla despliega la pila completa de Firecrawl autoalojada:\n\n- **api** — proceso principal de Firecrawl. Ejecuta `harness.js --start-docker`, que gestiona el servidor API, worker, extract-worker y varios subprocesos worker de la cola NUQ dentro del mismo contenedor.\n- **playwright** — microservicio de automatización del navegador para páginas con JavaScript.\n- **redis** — almacén para caché y limitación de velocidad.\n- **rabbitmq** — broker para la cola de tareas NUQ.\n- **postgres** — Postgres 17 + pg_cron, con el esquema de cola NUQ precargado.\n\n## Recursos recomendados\n\nFirecrawl consume muchos recursos. El `docker-compose.yaml` upstream recomienda al menos **4 vCPU / 8 GB RAM** para el servicio `api` y **2 vCPU / 4 GB RAM** para `playwright`. Recomendamos desplegar en un plan Pro o un servidor dedicado.\n\n## Configuración\n\nSolo el dominio es obligatorio. El rastreo y la extracción principales funcionan sin ningún LLM configurado.\n\n**LLM extract (opcional, trae tu propio proveedor compatible con OpenAI):** el formulario de despliegue ofrece dos campos opcionales — **OpenAI API Key** y **OpenAI Base URL**. Introduce la clave de tu proveedor para habilitar las funciones LLM de Firecrawl (llm-extract, summary, `/v2/extract`, `/v2/agent`). Deja ambos en blanco para desplegar sin LLM.\n\n- **OpenAI directo:** define `OPENAI_API_KEY` y deja `OPENAI_BASE_URL` en blanco — Firecrawl usa el endpoint por defecto de OpenAI.\n- **Otros proveedores compatibles con OpenAI (OpenRouter, xAI, Ollama, un gateway autoalojado, …):** define tanto `OPENAI_API_KEY` como `OPENAI_BASE_URL` (p. ej. `https://openrouter.ai/api/v1`). También puedes definir `MODEL_NAME` en la pestaña env del servicio api. La lista completa de variables soportadas está en [`apps/api/src/config.ts`](https://github.com/firecrawl/firecrawl/blob/main/apps/api/src/config.ts).\n\nPuedes cambiar estos valores en cualquier momento en la pestaña env del servicio api y reiniciar el servicio.\n\n**Consideraciones:**\n- Algunos proveedores compatibles con OpenAI no exponen modelos de embedding. Cuando los embeddings no están disponibles, la ordenación de relevancia de enlaces durante el crawl se desactiva (los enlaces se devuelven sin ordenar); el resto de funciones LLM (extract, agent, summary) no se ven afectadas.\n- Algunas funciones de Firecrawl (browser-agent interactivo, manejo de citas directas) llaman a Google Gemini directamente vía `@ai-sdk/google` sin pasar por `OPENAI_BASE_URL`. Para habilitarlas, define también `GOOGLE_GENERATIVE_AI_API_KEY` en el servicio api.\n\n`BULL_AUTH_KEY` (que protege el panel interno Bull queue) se genera automáticamente; puedes verlo en la pestaña env del servicio api.\n\nLa autenticación está **deshabilitada** por defecto (`USE_DB_AUTHENTICATION=false`). El endpoint de la API es público — protege tu dominio con Cloudflare, un auth proxy o una ACL de red si está expuesto a Internet.\n\n## Prueba rápida\n\nTras el despliegue, llama al endpoint scrape:\n\n```bash\ncurl -X POST https://<your-domain>/v1/scrape \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"url\": \"https://docs.firecrawl.dev\"}'\n```\n\n## Panel de cola\n\nFirecrawl no tiene UI para usuarios finales — es un servicio solo de API. Para operadores, hay un [Bull Dashboard](https://github.com/felixmosh/bull-board) incorporado en:\n\n```\nhttps://<your-domain>/admin/<BULL_AUTH_KEY>/queues\n```\n\nÚsalo para monitorear el rendimiento de la cola, inspeccionar trabajos active / completed / failed y reintentar errores. Encuentra tu `BULL_AUTH_KEY` en la pestaña env del servicio **api**.\n\n## Versionado\n\nFirecrawl upstream no publica etiquetas semver — solo `:latest`, que se reconstruye cada vez que avanza la rama `main`. Para que tu despliegue sea reproducible, esta plantilla fija cada imagen por digest (`@sha256:...`). El pin actual corresponde a la build del **2026-05-04**. Las actualizaciones se publican como nuevas revisiones de la plantilla.\n\n## Referencias\n\n- GitHub: https://github.com/firecrawl/firecrawl\n- Documentación oficial: https://docs.firecrawl.dev/\n- Licencia: AGPL-3.0"
    id-ID:
        description: API web crawler dan scraper open-source untuk aplikasi AI, basis pengetahuan, dan pipeline data.
        readme: "# Firecrawl\n\n\U0001F680 [Firecrawl](https://github.com/firecrawl/firecrawl) adalah API web crawler dan scraper open-source untuk aplikasi AI, basis pengetahuan, dan pipeline data.\n\nTemplate ini men-deploy seluruh stack Firecrawl self-hosted:\n\n- **api** — proses utama Firecrawl. Menjalankan `harness.js --start-docker`, yang mengelola server API, worker, extract-worker, dan beberapa subproses worker antrian NUQ di dalam container yang sama.\n- **playwright** — microservice otomasi browser untuk halaman ber-JavaScript.\n- **redis** — penyimpanan cache dan rate-limit.\n- **rabbitmq** — broker untuk antrian tugas NUQ.\n- **postgres** — Postgres 17 + pg_cron, sudah di-load dengan skema antrian NUQ.\n\n## Rekomendasi sumber daya\n\nFirecrawl membutuhkan banyak sumber daya. `docker-compose.yaml` upstream merekomendasikan minimal **4 vCPU / 8 GB RAM** untuk service `api` dan **2 vCPU / 4 GB RAM** untuk `playwright`. Disarankan deploy di paket Pro atau dedicated server.\n\n## Konfigurasi\n\nHanya domain yang wajib diisi. Fitur inti crawling dan scraping bekerja tanpa LLM apa pun yang dikonfigurasi.\n\n**LLM extract (opsional, bawa provider kompatibel-OpenAI Anda sendiri):** form deploy menyediakan dua field opsional — **OpenAI API Key** dan **OpenAI Base URL**. Isi key provider Anda untuk mengaktifkan fitur LLM Firecrawl (llm-extract, summary, `/v2/extract`, `/v2/agent`). Kosongkan keduanya untuk deploy tanpa LLM.\n\n- **OpenAI langsung:** set `OPENAI_API_KEY` dan kosongkan `OPENAI_BASE_URL` — Firecrawl memakai endpoint default OpenAI.\n- **Provider kompatibel-OpenAI lain (OpenRouter, xAI, Ollama, gateway self-hosted, …):** set `OPENAI_API_KEY` dan `OPENAI_BASE_URL` (mis. `https://openrouter.ai/api/v1`). Anda juga bisa set `MODEL_NAME` di tab env service api. Daftar lengkap variabel yang didukung ada di [`apps/api/src/config.ts`](https://github.com/firecrawl/firecrawl/blob/main/apps/api/src/config.ts).\n\nNilai-nilai ini bisa diubah kapan saja di tab env service api lalu restart service.\n\n**Catatan:**\n- Sebagian provider kompatibel-OpenAI tidak menyediakan embedding model. Saat embedding tidak tersedia, ranking relevansi link saat crawl akan fallback ke \"tanpa ranking\"; fitur LLM lain (extract, agent, summary) tidak terpengaruh.\n- Beberapa fitur Firecrawl (browser-agent interaktif, penanganan direct-quote) memanggil Google Gemini langsung via `@ai-sdk/google` tanpa melalui `OPENAI_BASE_URL`. Untuk mengaktifkannya, set juga `GOOGLE_GENERATIVE_AI_API_KEY` di service api.\n\n`BULL_AUTH_KEY` (untuk melindungi Bull queue dashboard internal) dibuat otomatis; bisa dilihat di tab env service api.\n\nAutentikasi API **dinonaktifkan** secara default (`USE_DB_AUTHENTICATION=false`). Endpoint API bersifat publik — lindungi domain Anda dengan Cloudflare, auth proxy, atau ACL jaringan jika dipublikasikan ke internet.\n\n## Tes cepat\n\nSetelah deploy selesai, panggil endpoint scrape:\n\n```bash\ncurl -X POST https://<your-domain>/v1/scrape \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"url\": \"https://docs.firecrawl.dev\"}'\n```\n\n## Dashboard antrian\n\nFirecrawl tidak punya UI untuk pengguna akhir — ini adalah service API saja. Untuk operator, tersedia [Bull Dashboard](https://github.com/felixmosh/bull-board) bawaan di:\n\n```\nhttps://<your-domain>/admin/<BULL_AUTH_KEY>/queues\n```\n\nGunakan untuk memantau throughput antrian, melihat job active / completed / failed, dan menjalankan ulang error. `BULL_AUTH_KEY` bisa ditemukan di tab env service **api**.\n\n## Versi\n\nFirecrawl upstream tidak menerbitkan tag semver — hanya `:latest`, yang di-build ulang setiap kali branch `main` maju. Agar deploy Anda reprodusibel, template ini mengunci setiap image dengan digest (`@sha256:...`). Pin saat ini sesuai dengan build pada **2026-05-04**. Update dirilis sebagai revisi template baru.\n\n## Referensi\n\n- GitHub: https://github.com/firecrawl/firecrawl\n- Dokumentasi resmi: https://docs.firecrawl.dev/\n- Lisensi: AGPL-3.0"
    ja-JP:
        description: AI アプリケーション、ナレッジベース、データパイプライン向けのオープンソース Web クローラー / スクレイピング API。
        readme: "# Firecrawl\n\n\U0001F680 [Firecrawl](https://github.com/firecrawl/firecrawl) は AI アプリケーション、ナレッジベース、データパイプライン向けのオープンソース Web クローラー / スクレイピング API です。\n\nこのテンプレートはセルフホスト版 Firecrawl のフルスタックをデプロイします:\n\n- **api** — Firecrawl のメインプロセス。`harness.js --start-docker` を実行し、同一コンテナ内で API サーバー、worker、extract-worker、複数の NUQ キュー worker サブプロセスを管理します。\n- **playwright** — JavaScript レンダリングページ向けのブラウザ自動化マイクロサービス。\n- **redis** — キャッシュとレート制限用のストア。\n- **rabbitmq** — NUQ タスクキューのブローカー。\n- **postgres** — Postgres 17 + pg_cron、NUQ キュースキーマをプリロード済み。\n\n## リソース推奨値\n\nFirecrawl はリソース集約型のサービスです。upstream の `docker-compose.yaml` は `api` に最低 **4 vCPU / 8 GB RAM**、`playwright` に最低 **2 vCPU / 4 GB RAM** を推奨しています。Pro プランまたは専用サーバーへのデプロイを推奨します。\n\n## 設定\n\n必須項目はドメイン名のみです。コアのクロール / スクレイピング機能は LLM 設定なしで動作します。\n\n**LLM extract（オプション、OpenAI 互換プロバイダを持ち込み）：** デプロイフォームには **OpenAI API Key** と **OpenAI Base URL** の 2 つのオプション欄があります。プロバイダのキーを入力すると Firecrawl の LLM 機能（llm-extract、summary、`/v2/extract`、`/v2/agent`）が有効になります。両方を空のままにすると LLM なしでデプロイされます。\n\n- **OpenAI 直接：** `OPENAI_API_KEY` を設定し、`OPENAI_BASE_URL` は空のままにします。Firecrawl は OpenAI のデフォルトエンドポイントを使用します。\n- **その他の OpenAI 互換プロバイダ（OpenRouter、xAI、Ollama、セルフホストのゲートウェイ …）：** `OPENAI_API_KEY` と `OPENAI_BASE_URL`（例: `https://openrouter.ai/api/v1`）の両方を設定します。api サービスの env タブで `MODEL_NAME` も設定できます。サポートされる変数の完全なリストは [`apps/api/src/config.ts`](https://github.com/firecrawl/firecrawl/blob/main/apps/api/src/config.ts) を参照してください。\n\nこれらの値は api サービスの env タブでいつでも変更でき、変更後にサービスを再起動するだけです。\n\n**注意点：**\n- 一部の OpenAI 互換プロバイダは embedding model を提供していません。embedding が利用できない場合、Crawl のリンク関連度ランキングは「ランキングなし」にフォールバックしますが、その他の LLM 機能（extract、agent、summary）には影響しません。\n- 一部の Firecrawl 機能（インタラクティブ browser-agent、direct-quote 処理）は `OPENAI_BASE_URL` を経由せず、`@ai-sdk/google` 経由で直接 Google Gemini を呼び出します。これらを有効化するには、api サービスに `GOOGLE_GENERATIVE_AI_API_KEY` も設定してください。\n\n`BULL_AUTH_KEY`（内蔵 Bull queue dashboard を保護する認証キー）は自動生成されます。api サービスの env タブから確認できます。\n\nAPI 認証はデフォルトで **無効** です（`USE_DB_AUTHENTICATION=false`）。API エンドポイントは公開状態のため、インターネットに公開する場合は Cloudflare、認証プロキシ、ネットワーク ACL などでドメインを保護してください。\n\n## クイックテスト\n\nデプロイ完了後、scrape エンドポイントを呼び出します:\n\n```bash\ncurl -X POST https://<your-domain>/v1/scrape \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"url\": \"https://docs.firecrawl.dev\"}'\n```\n\n## キュー管理ダッシュボード\n\nFirecrawl にはエンドユーザー向け UI はなく、API のみのサービスです。運用者向けに [Bull Dashboard](https://github.com/felixmosh/bull-board) が組み込まれており、以下の URL でアクセスできます:\n\n```\nhttps://<your-domain>/admin/<BULL_AUTH_KEY>/queues\n```\n\nキューのスループット監視、active / completed / failed ジョブの確認、失敗ジョブのリトライが可能です。`BULL_AUTH_KEY` は **api** サービスの env タブから確認できます。\n\n## バージョン情報\n\nFirecrawl upstream は semver タグを公開していません — `:latest` のみで、main ブランチが進むたびに再ビルドされます。再現性のあるデプロイのために、このテンプレートでは各 image を digest（`@sha256:...`）で固定しており、現在は **2026-05-04** のビルドに対応します。アップデートは新しいテンプレートリビジョンとして公開されます。\n\n## 参考資料\n\n- GitHub: https://github.com/firecrawl/firecrawl\n- 公式ドキュメント: https://docs.firecrawl.dev/\n- ライセンス: AGPL-3.0"
    zh-CN:
        description: 开源网页爬虫与抓取 API，专为 AI 应用、知识库和数据管道设计。
        readme: "# Firecrawl\n\n\U0001F680 [Firecrawl](https://github.com/firecrawl/firecrawl) 是一个开源的网页爬虫与抓取 API，专为 AI 应用、知识库和数据管道设计。\n\n此模板部署完整的自托管 Firecrawl 堆栈：\n\n- **api** — Firecrawl 主程序。执行 `harness.js --start-docker`，在同一容器内管理 API 服务器、worker、extract-worker，以及多个 NUQ queue worker 子进程。\n- **playwright** — 处理 JavaScript 渲染页面的浏览器自动化微服务。\n- **redis** — 缓存与速率限制存储。\n- **rabbitmq** — NUQ 任务队列的 broker。\n- **postgres** — Postgres 17 + pg_cron，预载 NUQ queue schema。\n\n## 资源建议\n\nFirecrawl 是资源密集型服务。upstream 的 `docker-compose.yaml` 建议 `api` 服务至少配置 **4 vCPU / 8 GB RAM**，`playwright` 至少 **2 vCPU / 4 GB RAM**。建议部署在 Pro 套餐或 dedicated server 上。\n\n## 配置\n\n必填的只有域名。核心的爬取与抓取功能无需任何 LLM 配置即可运行。\n\n**LLM extract（可选，自备 OpenAI 兼容 provider）：** 部署表单提供两个可选字段——**OpenAI API Key** 与 **OpenAI Base URL**。填入您的 provider key 即可启用 Firecrawl 的 LLM 功能（llm-extract、summary、`/v2/extract`、`/v2/agent`）。两者都留空则以无 LLM 模式部署。\n\n- **OpenAI 直连：** 设置 `OPENAI_API_KEY`，`OPENAI_BASE_URL` 留空——Firecrawl 会使用 OpenAI 默认端点。\n- **其他 OpenAI 兼容 provider（OpenRouter、xAI、Ollama、自建 gateway…）：** 同时设置 `OPENAI_API_KEY` 与 `OPENAI_BASE_URL`（例如 `https://openrouter.ai/api/v1`）。也可在 api 服务 env tab 设置 `MODEL_NAME`。完整支持的变量清单见 [`apps/api/src/config.ts`](https://github.com/firecrawl/firecrawl/blob/main/apps/api/src/config.ts)。\n\n这些值随时可在 api 服务 env tab 修改，改完 restart 服务即可。\n\n**注意事项：**\n- 部分 OpenAI 兼容 provider 不提供 embedding model。无法获取 embedding 时，Crawl 链接相关度排序会退化为原顺序，其他 LLM 功能（extract、agent、summary）不受影响。\n- 少数 Firecrawl 功能（交互式 browser-agent、direct-quote 处理）写死通过 `@ai-sdk/google` 调用 Google Gemini，不走 `OPENAI_BASE_URL`。若要启用，请在 api 服务额外设置 `GOOGLE_GENERATIVE_AI_API_KEY`。\n\n`BULL_AUTH_KEY`（保护内置 Bull queue dashboard）会自动生成，可在 api 服务 env tab 查看。\n\n默认 **不启用** API 认证（`USE_DB_AUTHENTICATION=false`）。API 端点是公开的——若部署于公网，请使用 Cloudflare、auth proxy 或网络 ACL 保护您的域名。\n\n## 快速测试\n\n部署完成后，调用 scrape 端点：\n\n```bash\ncurl -X POST https://<your-domain>/v1/scrape \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"url\": \"https://docs.firecrawl.dev\"}'\n```\n\n## Queue 管理面板\n\nFirecrawl 没有给终端用户的 UI，它是 API-only 服务。运维用的内置 [Bull Dashboard](https://github.com/felixmosh/bull-board) 挂载于：\n\n```\nhttps://<your-domain>/admin/<BULL_AUTH_KEY>/queues\n```\n\n可监控 queue 吞吐量、查看 active / completed / failed jobs、重跑失败任务。`BULL_AUTH_KEY` 可在 **api** 服务的 env tab 查到。\n\n## 版本信息\n\nFirecrawl upstream 没有发布 semver 标签——只有 `:latest`，每次 main 分支推进就会重建。为了让您的部署可复现，本模板将每个 image 通过 digest（`@sha256:...`）固定，当前对应 **2026-05-04** 的 build。后续更新会以新版模板的形式发布。\n\n## 参考资料\n\n- GitHub: https://github.com/firecrawl/firecrawl\n- 官方文档: https://docs.firecrawl.dev/\n- License: AGPL-3.0"
    zh-TW:
        description: 開源網頁爬蟲與擷取 API，專為 AI 應用、知識庫和資料管線設計。
        readme: "# Firecrawl\n\n\U0001F680 [Firecrawl](https://github.com/firecrawl/firecrawl) 是一個開源的網頁爬蟲與擷取 API，專為 AI 應用、知識庫和資料管線設計。\n\n此模板部署完整的自架 Firecrawl 堆疊：\n\n- **api** — Firecrawl 主程式。執行 `harness.js --start-docker`，在同一個容器內管理 API 伺服器、worker、extract-worker，以及多個 NUQ queue worker 子行程。\n- **playwright** — 處理 JavaScript 渲染頁面的瀏覽器自動化微服務。\n- **redis** — 快取與速率限制儲存。\n- **rabbitmq** — NUQ 任務佇列的 broker。\n- **postgres** — Postgres 17 + pg_cron，預載 NUQ queue schema。\n\n## 資源建議\n\nFirecrawl 是資源密集型服務。upstream 的 `docker-compose.yaml` 建議 `api` 服務至少配置 **4 vCPU / 8 GB RAM**，`playwright` 至少 **2 vCPU / 4 GB RAM**。建議部署在 Pro 方案或 dedicated server 上。\n\n## 設定\n\n必填的只有網域。核心的爬取與擷取功能不需要任何 LLM 設定即可運作。\n\n**LLM extract（可選，自備 OpenAI 相容 provider）：** 部署表單提供兩個可選欄位——**OpenAI API Key** 與 **OpenAI Base URL**。填入你的 provider key 即可啟用 Firecrawl 的 LLM 功能（llm-extract、summary、`/v2/extract`、`/v2/agent`）。兩者都留空則以無 LLM 模式部署。\n\n- **OpenAI 直連：** 設 `OPENAI_API_KEY`，`OPENAI_BASE_URL` 留空——Firecrawl 會使用 OpenAI 預設端點。\n- **其他 OpenAI 相容 provider（OpenRouter、xAI、Ollama、自架 gateway…）：** 同時設定 `OPENAI_API_KEY` 與 `OPENAI_BASE_URL`（例如 `https://openrouter.ai/api/v1`）。也可在 api 服務 env tab 設 `MODEL_NAME`。完整支援的變數清單見 [`apps/api/src/config.ts`](https://github.com/firecrawl/firecrawl/blob/main/apps/api/src/config.ts)。\n\n這些值隨時可在 api 服務 env tab 修改，改完 restart 服務即可。\n\n**注意事項：**\n- 部分 OpenAI 相容 provider 不提供 embedding model。無法取得 embedding 時，Crawl 連結相關度排序會退化為原順序，其他 LLM 功能（extract、agent、summary）不受影響。\n- 少數 Firecrawl 功能（互動式 browser-agent、direct-quote 處理）寫死透過 `@ai-sdk/google` 呼叫 Google Gemini，不走 `OPENAI_BASE_URL`。若要啟用，請另外在 api 服務設 `GOOGLE_GENERATIVE_AI_API_KEY`。\n\n`BULL_AUTH_KEY`（保護內建 Bull queue dashboard）會自動生成，可在 api 服務 env tab 查看。\n\n預設 **不啟用** API 認證（`USE_DB_AUTHENTICATION=false`）。API 端點是公開的——若部署於公開網路，請使用 Cloudflare、auth proxy 或網路 ACL 保護你的網域。\n\n## 快速測試\n\n部署完成後，呼叫 scrape 端點：\n\n```bash\ncurl -X POST https://<your-domain>/v1/scrape \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"url\": \"https://docs.firecrawl.dev\"}'\n```\n\n## Queue 管理面板\n\nFirecrawl 沒有給終端用戶的 UI，它是 API-only 服務。維運用的內建 [Bull Dashboard](https://github.com/felixmosh/bull-board) 掛在：\n\n```\nhttps://<your-domain>/admin/<BULL_AUTH_KEY>/queues\n```\n\n可監控 queue 吞吐量、檢視 active / completed / failed jobs、重跑失敗任務。`BULL_AUTH_KEY` 可在 **api** 服務的 env tab 查到。\n\n## 版本資訊\n\nFirecrawl upstream 沒有發行 semver 標籤——只有 `:latest`，每次 main 分支推進就會重建。為了讓你的部署可重現，這個模板把每個 image 用 digest（`@sha256:...`）釘住，目前釘的是 **2026-05-04** 那個 build。後續更新會以新版模板的形式釋出。\n\n## 參考資料\n\n- GitHub: https://github.com/firecrawl/firecrawl\n- 官方文件: https://docs.firecrawl.dev/\n- License: AGPL-3.0"
