Sign inSign up
firecrawl-ui logo

obeoneorg/firecrawl-ui

By obeoneorg

β€’Updated 7 days ago

Firecrawl UI interact with the Firecrawl API. It allows you to scrape pages, launch crawl and more!

Image
Networking
API management
Developer tools
0

10K+

obeoneorg/firecrawl-ui repository overview

Firecrawl UI

⁠Firecrawl UI

Vue Vite TypeScript Docker License CI Release Docker Pulls


Firecrawl UI is a single-page Vue 3 app that puts the Firecrawl API⁠ tools behind a simple request/response interface. You don't need to write any integration code: open the app, drop in a URL, and read the scraped content, crawl results, or extracted data right in the browser. Your API key and data stay local, and you can point it at the hosted Firecrawl service or your own self-hosted instance.

⁠✨ Features

FeatureDescription
πŸ”—URL launcherPaste a URL on the home, pick an action, land in the tool pre-filled
πŸ“„ScrapeTurn a single page into clean markdown, HTML, links or structured data
πŸ“šBatch scrapeScrape a list of URLs in one job and export the results together
πŸ•·οΈCrawlTraverse a whole site with depth, include/exclude rules and live progress
🧠ExtractPull structured fields from URLs with a prompt or schema (AI)
πŸ—ΊοΈMapList every reachable URL of a site to understand its structure
πŸ”SearchQuery the web and get ranked results with optional page content
πŸ•˜HistoryReopen past jobs by ID; only metadata is kept, in your browser
πŸŒ—Light / darkGlass + aurora theme, dark by default, remembered across sessions
πŸ”‘Local configAPI key and base URL stored in your browser, never sent anywhere else
🏠Self-hostingPoint the base URL at your own Firecrawl instance (with or without a key)

β πŸš€ Demo

Try it now, no install needed: https://firecrawl-ui.obeone.cloud⁠. Open the settings page and add your API key (or a self-hosted base URL) to get started.

Firecrawl UI home

β πŸ“¦ Installation

⁠Local
git clone https://github.com/obeone/firecrawl-ui.git
cd firecrawl-ui
npm install
npm run dev

Open the URL printed in your terminal (default http://localhost:5173/⁠), then set your API key in the settings page.

⁠🐳 Docker
docker run -p 8080:8080 obeoneorg/firecrawl-ui

Open http://localhost:8080/⁠. Prebuilt images:

  • docker.io/obeoneorg/firecrawl-ui
  • ghcr.io/obeone/firecrawl-ui

β πŸ–ΌοΈ Screenshots

ScrapeCrawl
ScrapeCrawl
ExtractMap
ExtractMap

Each tool is a two-pane playground: build the request on the left, read the response (preview, JSON, links and more) on the right. Option groups fold away so long forms stay readable.

β βš™οΈ Configuration

You can configure access two ways. The app shows a setup prompt on the home until either an API key or a custom API URL (for a self-hosted instance) is set.

In the app: open the settings page (gear icon) and enter your API key and/or base URL. Values are saved to localStorage.

Environment variables: create a .env file in the project root. These are read by src/config/api.ts.

VITE_FIRECRAWL_API_KEY=your_api_key
VITE_FIRECRAWL_API_BASE_URL=https://api.firecrawl.dev
VariableDescriptionDefault
VITE_FIRECRAWL_API_KEYFirecrawl API key(empty)
VITE_FIRECRAWL_API_BASE_URLFirecrawl service roothttps://api.firecrawl.dev

Warning

`VITE_*` variables are inlined into the JavaScript bundle at build time. A `VITE_FIRECRAWL_API_KEY` set when building is readable by anyone who can load the app, so only use it for a private deployment. For a shared or public deployment, leave it empty and let each user enter a key in the settings page, where it stays in their own browser's `localStorage`.

A self-hosted instance without authentication needs no key: set only the base URL. The settings page has a Test connection button (it calls GET /v2/team/queue-status, which uses no credits) and a Forget key button that removes the key saved in the browser.

Precedence is localStorage > VITE_* env > default. Any trailing /v1 or /v2 on the base URL is stripped automatically; the adapter targets v2.

β πŸ› οΈ Commands

CommandDescription
npm run devStart the dev server with hot reload
npm run buildBuild to dist/
npm run previewPreview the production build locally
npm run typecheckType-check with vue-tsc
npm run lintRun ESLint
npm testRun the Vitest unit tests
npm run formatFormat with Prettier
DockerDescription
docker build -t firecrawl-ui .Build the image locally
docker run -p 8080:8080 firecrawl-uiServe via Nginx on port 8080

The image is a multi-stage build (Node 26, then nginx-unprivileged). A custom nginx.conf rewrites unknown paths to index.html for client-side routing and sends a strict Content-Security-Policy with the usual security headers (X-Frame-Options, X-Content-Type-Options, Referrer-Policy, Permissions-Policy). The policy is also embedded as a <meta> tag in the build, so it applies behind any static host.

Published images (ghcr.io/obeone/firecrawl-ui, obeoneorg/firecrawl-ui) are built only after CI passes and signed with cosign.

Image tagPoints to
latestThe last commit on main
sha-<commit>One exact commit
YYYY.M.REVA release, e.g. 2026.11.1
YYYY.MThe latest release of that month

Releases use CalVer vYYYY.M.REV, where REV counts the releases of the month from 1. Pushing such a tag runs CI, which publishes the images above and deploys the site (the site only changes on a release):

git tag v2026.11.1
git push origin v2026.11.1

The version is never written by hand: CI derives it from git describe and shows it on the About page (2026.11.1-3-gabc1234 for commits after a release, dev for a build outside Git).

β πŸ”Œ API

The app targets the Firecrawl v2 API (/v2/*) through the hand-written adapter in src/services/firecrawl.ts. See the Firecrawl v2 API reference⁠ for the endpoints and payloads.

⁠Compatibility
ToolAPIStatus
Scrape, Batch Scrape, Crawl, Extract/v2Supported
Map, Search, API configuration, Billing/v2Supported
Deep Research (/research)/v1ΒΉDeprecated (v1)
LLMs.txt (/llmstxt)/v1ΒΉDeprecated (v1)

ΒΉ Tries /v2 first, then falls back to /v1.

Deep Research and LLMs.txt generation are not part of the v2 API. Firecrawl deprecated both legacy v1 endpoints and removes them from its cloud API on 10 December 2026, 15:00 UTC. The UI keeps both tools, labelled v1 in the top bar and with a notice on their pages, for self-hosted installs that still serve them. Upstream replacements: the Agent endpoint or a loop on Search for Deep Research (migration guide⁠), Map then Batch Scrape for LLMs.txt (migration guide⁠).

⁠🧭 Architecture

flowchart TB
    U["You (in the browser)"] --> H["Home launcher<br/>URL + action"]
    H --> V["Tool views<br/>Scrape Β· Crawl Β· Extract Β· Map Β· Search"]
    V --> AD["API adapter<br/>src/services/firecrawl.ts"]
    AD -->|"v2 requests"| FC[("Firecrawl API v2")]
    CFG["API key / base URL<br/>localStorage or VITE_* env"] -.-> AD

⁠🀝 Contributing

Contributions are welcome. Run npm run format:check, npm run lint, npm run typecheck and npm test before opening a pull request; CI blocks on each of them. PR titles follow [firecrawl-ui] <Title>.

β πŸ“ License

Released under the MIT⁠ license. Powered by Firecrawl⁠.

Made by GrΓ©goire Compagnon (obeone).

Tag summary

Content type

Image

Digest

sha256:7e7a7ee2a…

Size

24.8 MB

Last updated

7 days ago

docker pull obeoneorg/firecrawl-ui