feat(server): add OSS webclaw-server REST API binary (closes #29)
Self-hosters hitting docs/self-hosting were promised three binaries
but the OSS Docker image only shipped two. webclaw-server lived in
the closed-source hosted-platform repo, which couldn't be opened. This
adds a minimal axum REST API in the OSS repo so self-hosting actually
works without pretending to ship the cloud platform.
Crate at crates/webclaw-server/. Stateless, no database, no job queue,
single binary. Endpoints: GET /health, POST /v1/{scrape, crawl, map,
batch, extract, summarize, diff, brand}. JSON shapes mirror
api.webclaw.io for the endpoints OSS can support, so swapping between
self-hosted and hosted is a base-URL change.
Auth: optional bearer token via WEBCLAW_API_KEY / --api-key. Comparison
is constant-time (subtle::ConstantTimeEq). Open mode (no key) is
allowed and binds 127.0.0.1 by default; the Docker image flips
WEBCLAW_HOST=0.0.0.0 so the container is reachable out of the box.
Hard caps to keep naive callers from OOMing the process: crawl capped
at 500 pages synchronously, batch capped at 100 URLs / 20 concurrent.
For unbounded crawls or anti-bot bypass the docs point users at the
hosted API.
Dockerfile + Dockerfile.ci updated to copy webclaw-server into
/usr/local/bin and EXPOSE 3000. Workspace version bumped to 0.4.0
(new public binary).
2026-04-22 12:25:11 +02:00
|
|
|
//! POST /v1/map — discover URLs from a site's sitemaps.
|
|
|
|
|
//!
|
|
|
|
|
//! Walks robots.txt + common sitemap paths, recursively resolves
|
|
|
|
|
//! `<sitemapindex>` files, and returns the deduplicated list of URLs.
|
|
|
|
|
|
|
|
|
|
use axum::{Json, extract::State};
|
|
|
|
|
use serde::Deserialize;
|
|
|
|
|
use serde_json::{Value, json};
|
|
|
|
|
use webclaw_fetch::sitemap;
|
|
|
|
|
|
|
|
|
|
use crate::{error::ApiError, state::AppState};
|
|
|
|
|
|
|
|
|
|
#[derive(Debug, Deserialize)]
|
|
|
|
|
pub struct MapRequest {
|
|
|
|
|
pub url: String,
|
|
|
|
|
/// When true, return the full SitemapEntry objects (with lastmod,
|
|
|
|
|
/// priority, changefreq). Defaults to false → bare URL strings,
|
|
|
|
|
/// matching the hosted-API shape.
|
|
|
|
|
#[serde(default)]
|
|
|
|
|
pub include_metadata: bool,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub async fn map(
|
|
|
|
|
State(state): State<AppState>,
|
|
|
|
|
Json(req): Json<MapRequest>,
|
|
|
|
|
) -> Result<Json<Value>, ApiError> {
|
|
|
|
|
if req.url.trim().is_empty() {
|
|
|
|
|
return Err(ApiError::bad_request("`url` is required"));
|
|
|
|
|
}
|
2026-05-04 14:30:06 +02:00
|
|
|
let url = webclaw_fetch::url_security::validate_public_http_url(&req.url).await?;
|
feat(server): add OSS webclaw-server REST API binary (closes #29)
Self-hosters hitting docs/self-hosting were promised three binaries
but the OSS Docker image only shipped two. webclaw-server lived in
the closed-source hosted-platform repo, which couldn't be opened. This
adds a minimal axum REST API in the OSS repo so self-hosting actually
works without pretending to ship the cloud platform.
Crate at crates/webclaw-server/. Stateless, no database, no job queue,
single binary. Endpoints: GET /health, POST /v1/{scrape, crawl, map,
batch, extract, summarize, diff, brand}. JSON shapes mirror
api.webclaw.io for the endpoints OSS can support, so swapping between
self-hosted and hosted is a base-URL change.
Auth: optional bearer token via WEBCLAW_API_KEY / --api-key. Comparison
is constant-time (subtle::ConstantTimeEq). Open mode (no key) is
allowed and binds 127.0.0.1 by default; the Docker image flips
WEBCLAW_HOST=0.0.0.0 so the container is reachable out of the box.
Hard caps to keep naive callers from OOMing the process: crawl capped
at 500 pages synchronously, batch capped at 100 URLs / 20 concurrent.
For unbounded crawls or anti-bot bypass the docs point users at the
hosted API.
Dockerfile + Dockerfile.ci updated to copy webclaw-server into
/usr/local/bin and EXPOSE 3000. Workspace version bumped to 0.4.0
(new public binary).
2026-04-22 12:25:11 +02:00
|
|
|
|
2026-05-04 14:30:06 +02:00
|
|
|
let entries = sitemap::discover(state.fetch(), url.as_str()).await?;
|
feat(server): add OSS webclaw-server REST API binary (closes #29)
Self-hosters hitting docs/self-hosting were promised three binaries
but the OSS Docker image only shipped two. webclaw-server lived in
the closed-source hosted-platform repo, which couldn't be opened. This
adds a minimal axum REST API in the OSS repo so self-hosting actually
works without pretending to ship the cloud platform.
Crate at crates/webclaw-server/. Stateless, no database, no job queue,
single binary. Endpoints: GET /health, POST /v1/{scrape, crawl, map,
batch, extract, summarize, diff, brand}. JSON shapes mirror
api.webclaw.io for the endpoints OSS can support, so swapping between
self-hosted and hosted is a base-URL change.
Auth: optional bearer token via WEBCLAW_API_KEY / --api-key. Comparison
is constant-time (subtle::ConstantTimeEq). Open mode (no key) is
allowed and binds 127.0.0.1 by default; the Docker image flips
WEBCLAW_HOST=0.0.0.0 so the container is reachable out of the box.
Hard caps to keep naive callers from OOMing the process: crawl capped
at 500 pages synchronously, batch capped at 100 URLs / 20 concurrent.
For unbounded crawls or anti-bot bypass the docs point users at the
hosted API.
Dockerfile + Dockerfile.ci updated to copy webclaw-server into
/usr/local/bin and EXPOSE 3000. Workspace version bumped to 0.4.0
(new public binary).
2026-04-22 12:25:11 +02:00
|
|
|
|
|
|
|
|
let body = if req.include_metadata {
|
|
|
|
|
json!({
|
|
|
|
|
"url": req.url,
|
|
|
|
|
"count": entries.len(),
|
|
|
|
|
"urls": entries,
|
|
|
|
|
})
|
|
|
|
|
} else {
|
|
|
|
|
let urls: Vec<&str> = entries.iter().map(|e| e.url.as_str()).collect();
|
|
|
|
|
json!({
|
|
|
|
|
"url": req.url,
|
|
|
|
|
"count": urls.len(),
|
|
|
|
|
"urls": urls,
|
|
|
|
|
})
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
Ok(Json(body))
|
|
|
|
|
}
|