# Easel documentation

> Deploy, operate, and protect modern web applications on Easel. Prefer Markdown (append `.md` to any docs URL, or send `Accept: text/markdown`). Live tools: MCP at `/api/mcp`. Full corpus: `/llms-full.txt`.

## Docs

- [Easel API](https://easel.sh/docs/api): Public REST API status for Easel.
- [Common workflows](https://easel.sh/docs/examples): Practical Easel deployment patterns mapped to step-by-step guides.
- [Getting started](https://easel.sh/docs/getting-started): Import a Git repository, deploy it, create a Preview, and release it to Production.
- [Easel documentation](https://easel.sh/docs): Deploy, operate, and protect modern web applications on Easel.
- [Store and expire data in Runtime Cache](https://easel.sh/docs/runtime-cache): Use getCache() for shared key/value cache across function isolates, with tags and plan quotas.
- [Easel SDKs](https://easel.sh/docs/sdk): Official language SDK status for Easel.
- [Troubleshooting](https://easel.sh/docs/troubleshooting): Fix common DNS, TLS, cache, and WAF issues on Easel.
- [Caching](https://easel.sh/docs/cdn/caching): How Easel caches static assets and dynamic HTTP responses at the CDN.
- [Compression](https://easel.sh/docs/cdn/compression): How Easel compresses eligible responses with Brotli and gzip.
- [Request and response headers](https://easel.sh/docs/cdn/headers): Trusted platform headers Easel adds for routing, observability, security, and cache diagnostics.
- [HTTPS and TLS](https://easel.sh/docs/cdn/https-and-tls): Automatic HTTPS, TLS certificates, and custom domains on Easel.
- [CDN](https://easel.sh/docs/cdn): How Easel’s delivery network handles security, routing, caching, compression, and HTTPS for every deployment.
- [Revalidation and purging](https://easel.sh/docs/cdn/revalidation): Refresh or invalidate CDN and Runtime Cache content before its TTL expires.
- [Static files](https://easel.sh/docs/cdn/static-files): How build output is deployed as versioned static assets and served without compute.
- [CDN troubleshooting](https://easel.sh/docs/cdn/troubleshooting): Diagnose caching, redirects, compression, HTTPS, and routing issues on Easel CDN.
- [Authenticate the CLI](https://easel.sh/docs/cli/authentication): Log in to Easel from the CLI, use API tokens, and sign out.
- [Deploy from the CLI](https://easel.sh/docs/cli/deploy): Upload a local project and create a preview or production deployment with easel deploy.
- [List and inspect deployments](https://easel.sh/docs/cli/deployments): List and inspect Easel deployments from the CLI.
- [Easel CLI](https://easel.sh/docs/cli): Install and use the Easel CLI to authenticate, link projects, inspect deployments, and stream request logs.
- [Query request logs](https://easel.sh/docs/cli/logs): Query and follow request logs for Easel projects from the CLI.
- [Link a project](https://easel.sh/docs/cli/projects): Link a local directory or monorepo to Easel project(s) for CLI commands.
- [Domains and TLS](https://easel.sh/docs/delivery/domains-and-tls): How hostnames select deployments and where to configure DNS, certificates, and HTTPS.
- [Redirects and rewrites](https://easel.sh/docs/delivery/redirects-and-rewrites): Route visitors and internal requests without changing application code.
- [Routing](https://easel.sh/docs/delivery/routing): Understand how Easel selects deployments, static assets, middleware, cache entries, and Functions for incoming requests.
- [Add a custom domain](https://easel.sh/docs/domains/add-a-domain): Add an apex domain or subdomain to an Easel project.
- [DNS configuration](https://easel.sh/docs/domains/dns): Configure apex domains and subdomains to route traffic to Easel.
- [Domains](https://easel.sh/docs/domains): Connect custom domains to Easel projects and manage DNS, HTTPS, and routing.
- [Migrate a domain to Easel](https://easel.sh/docs/domains/migrate): Move an active domain to Easel while minimizing downtime.
- [Domain redirects](https://easel.sh/docs/domains/redirects): Redirect alternate domains to a canonical hostname.
- [Domain reference](https://easel.sh/docs/domains/reference): Reference for domain types, records, statuses, and terminology.
- [Remove or move a domain](https://easel.sh/docs/domains/remove-a-domain): Detach a custom domain from a project or assign it elsewhere.
- [HTTPS and TLS for custom domains](https://easel.sh/docs/domains/tls): Learn how Easel provisions and renews certificates for custom domains.
- [Domain troubleshooting](https://easel.sh/docs/domains/troubleshooting): Diagnose domain DNS, TLS, redirects, and routing problems.
- [Domain verification](https://easel.sh/docs/domains/verification): How Easel confirms that DNS routes your domain to the platform.
- [Wildcard domains](https://easel.sh/docs/domains/wildcards): Current support status for routing many subdomains to one Easel project.
- [Build configuration](https://easel.sh/docs/deployments/build-configuration): Configure the source directory, install command, build command, output, runtime, and environment used by Easel builds.
- [Creating deployments](https://easel.sh/docs/deployments/create): Create Easel deployments from Git, the CLI, or the dashboard.
- [Domains and deployments](https://easel.sh/docs/deployments/domains): Understand how project domains route to Production deployments.
- [Deployment environments](https://easel.sh/docs/deployments/environments): Understand Preview and Production configuration in Easel.
- [Git deployments](https://easel.sh/docs/deployments/git): Configure automatic deployments from branches and pull requests.
- [Deployments](https://easel.sh/docs/deployments): Learn how Easel builds, publishes, and manages versions of your application.
- [Managing deployments](https://easel.sh/docs/deployments/manage): Inspect, cancel, and spin down Easel deployments.
- [Monorepos](https://easel.sh/docs/deployments/monorepos): Configure and deploy multiple Easel projects from one repository.
- [Preview deployments](https://easel.sh/docs/deployments/previews): Test branches and pull requests before releasing them to production.
- [Production releases](https://easel.sh/docs/deployments/production-releases): Build, validate, promote, observe, and roll back Production deployments without confusing Ready with Current.
- [Promoting deployments](https://easel.sh/docs/deployments/promote): Assign a Ready Production deployment to your production domains.
- [Rolling back deployments](https://easel.sh/docs/deployments/rollback): Restore a previous Production deployment without rebuilding it.
- [Deployment troubleshooting](https://easel.sh/docs/deployments/troubleshooting): Diagnose deployment creation, build, publication, and routing problems.
- [Deployment URLs](https://easel.sh/docs/deployments/urls): Understand unique deployment URLs, branch previews, and production domains.
- [Framework guides](https://easel.sh/docs/framework-guides): Deploy frontend and full-stack frameworks to Easel.
- [Next.js on Easel](https://easel.sh/docs/framework-guides/nextjs): Deploy App Router and Pages Router applications to Easel with support for server rendering, streaming, Server Actions, route handlers, middleware, image optimization, and framework-native caching.
- [Nuxt on Easel](https://easel.sh/docs/framework-guides/nuxt): Deploy Nuxt applications to Easel with SSR, streaming, API routes, hybrid rendering, and Nitro-powered caching.
- [React Router on Easel](https://easel.sh/docs/framework-guides/react-router): Deploy full-stack React Router 7 and 8 applications to Easel with server rendering, streaming, loaders, actions, middleware, static prerendering, and SPA support.
- [SvelteKit on Easel](https://easel.sh/docs/framework-guides/sveltekit): Deploy SvelteKit applications to Easel with SSR, streaming, prerendering, form actions, hooks, and API endpoints.
- [TanStack Start on Easel](https://easel.sh/docs/framework-guides/tanstack-start): Deploy full-stack TanStack Start applications to Easel with SSR, streaming, server functions, and Nitro.
- [Vite on Easel](https://easel.sh/docs/framework-guides/vite): Deploy Vite applications to Easel as globally cached static sites and single-page applications.
- [Function configuration](https://easel.sh/docs/functions/configuration): Configure Node.js version, CPU tier, duration, build settings, and environment variables for Easel Functions.
- [Functions](https://easel.sh/docs/functions): How Easel Functions run server-rendered pages, API routes, and other dynamic application handlers.
- [Function limits](https://easel.sh/docs/functions/limits): Duration, memory, CPU, request size, and other limits that apply to Easel Functions.
- [Function regions](https://easel.sh/docs/functions/regions): Where Easel Functions run today, how that relates to the CDN, and how to read execution region on requests.
- [Function runtime](https://easel.sh/docs/functions/runtime): Instance lifecycle, concurrency, streaming, filesystem, networking, and shutdown behavior for Easel Functions.
- [CI/CD](https://easel.sh/docs/guides/ci-cd): Deploy from automated workflows using Git integration or the Easel CLI.
- [Common application patterns](https://easel.sh/docs/guides/common-application-patterns): Apply recommended Easel patterns for static sites, full-stack applications, APIs, webhooks, and scheduled work.
- [Debugging guide](https://easel.sh/docs/guides/debugging): Trace a failing request from deployment selection through routing, cache, and Function execution.
- [Performance guide](https://easel.sh/docs/guides/performance): Improve application latency, cache efficiency, build speed, and Function resource usage on Easel.
- [Application security guide](https://easel.sh/docs/guides/security): Apply Easel platform controls alongside secure application design.
- [Migrate from another platform](https://easel.sh/docs/migration/custom-platform): Move an application from a custom host or another PaaS to Easel.
- [Domain cutover](https://easel.sh/docs/migration/domain-cutover): Move production traffic to Easel while minimizing downtime.
- [Migrate to Easel](https://easel.sh/docs/migration): Plan and execute a controlled migration from another deployment platform.
- [Migrate from Netlify](https://easel.sh/docs/migration/netlify): Translate Netlify deploys, configuration, functions, and routing to Easel.
- [Production validation checklist](https://easel.sh/docs/migration/production-checklist): Verify an Easel deployment before routing production traffic to it.
- [Migration rollback](https://easel.sh/docs/migration/rollback): Return traffic to the previous platform when a production cutover fails.
- [Migrate from Vercel](https://easel.sh/docs/migration/vercel): Translate a Vercel application and deployment workflow to Easel.
- [Cache observability](https://easel.sh/docs/observability/cache): Understand cache hits, misses, bypasses, revalidation, and origin work.
- [Deployment events](https://easel.sh/docs/observability/deployments): Correlate builds, releases, and configuration changes with traffic.
- [Export observability data](https://easel.sh/docs/observability/export): Access observability data from the dashboard and CLI.
- [Function observability](https://easel.sh/docs/observability/functions): Inspect function invocations, cold starts, duration, and billing fields.
- [Observability](https://easel.sh/docs/observability): Understand application behavior across deployments, requests, functions, cache, and security events.
- [Observability retention](https://easel.sh/docs/observability/limits): Reference retention windows, capture limits, and query bounds for observability signals.
- [Logs](https://easel.sh/docs/observability/logs): Search application, function, and platform logs for Easel requests.
- [Metrics](https://easel.sh/docs/observability/metrics): Monitor application behavior with aggregated time-series data.
- [OpenTelemetry](https://easel.sh/docs/observability/opentelemetry): Instrument functions so application spans appear in Easel request Traces.
- [Request details](https://easel.sh/docs/observability/request-details): Inspect the complete path of a single request through Easel.
- [Request analytics](https://easel.sh/docs/observability/requests): Explore traffic, latency, status codes, cache behavior, and application activity.
- [Security events](https://easel.sh/docs/observability/security): Connect firewall and access-control decisions to request activity.
- [Tracing](https://easel.sh/docs/observability/tracing): Follow a request through edge routing, functions, and application spans.
- [Observability troubleshooting](https://easel.sh/docs/observability/troubleshooting): Diagnose missing logs, incomplete traces, and request-correlation problems.
- [Core concepts](https://easel.sh/docs/overview/core-concepts): Learn the deployment, environment, routing, cache, and observability terminology used by Easel.
- [Platform limits](https://easel.sh/docs/overview/limits): Find the canonical entry point for Easel platform limits.
- [Platform architecture](https://easel.sh/docs/overview/platform-architecture): Learn how Easel builds deployments and routes requests through delivery, security, cache, and compute layers.
- [Pricing and usage](https://easel.sh/docs/overview/pricing-and-usage): Understand the resources Easel meters and how application behavior affects usage.
- [What is Easel?](https://easel.sh/docs/overview/what-is-easel): Understand what Easel deploys, how the platform works, and where it fits in a modern application stack.
- [Configuration reference](https://easel.sh/docs/reference/configuration): Find Easel project, build, runtime, domain, and security configuration surfaces.
- [Error codes](https://easel.sh/docs/reference/error-codes): How to interpret Easel build, deployment, request, Function, security, and domain failures.
- [Limits reference](https://easel.sh/docs/reference/limits): Canonical index for Easel build, deployment, delivery, Function, security, and observability limits.
- [Regions](https://easel.sh/docs/reference/regions): Reference Easel edge delivery and Function compute regions.
- [Build pricing](https://easel.sh/docs/pricing/builds): How Build Execution is metered and what Hobby and Pro include.
- [Cache pricing](https://easel.sh/docs/pricing/cache): ISR and Runtime Cache 8 KB read and write units.
- [Usage credit and top-up](https://easel.sh/docs/pricing/credits): How Pro included usage credit and $10 top-ups apply after allowances.
- [Data transfer pricing](https://easel.sh/docs/pricing/data-transfer): Edge Data Transfer and Origin Transfer meters.
- [Function pricing](https://easel.sh/docs/pricing/functions): How Function Requests and Function Duration are metered.
- [Image Optimization pricing](https://easel.sh/docs/pricing/image-optimization): Image Transformations billed on cache MISS and STALE, with regional rates.
- [How Easel pricing works](https://easel.sh/docs/pricing): Plans, included allowances, and on-demand meters for Easel.
- [Regional rates](https://easel.sh/docs/pricing/regions): How region multipliers turn local usage into base-region-equivalent units.
- [Security pricing](https://easel.sh/docs/pricing/security): Rate Limiting and WAF inspection meters.
- [What each meter counts](https://easel.sh/docs/pricing/usage): How Easel maps traffic, functions, cache, builds, and security work to billed units.
- [Background work](https://easel.sh/docs/runtime/background-work): Choose between post-response work and durable background jobs.
- [Environment variables](https://easel.sh/docs/runtime/environment-variables): Configure build-time and runtime values for Preview and Production deployments.
- [Image optimization](https://easel.sh/docs/runtime/image-optimization): Serve responsive, transformed images through supported framework integrations.
- [Attack Mode](https://easel.sh/docs/security/attack-mode): Add a browser verification step when a project is under attack.
- [Bot traffic](https://easel.sh/docs/security/bots): Understand how Easel identifies and handles automated clients.
- [Custom firewall rules](https://easel.sh/docs/security/custom-rules): Match request properties and choose how Easel handles the traffic.
- [Deployment protection](https://easel.sh/docs/security/deployment-protection): Restrict access to previews, unique deployment URLs, and non-current deployments.
- [Firewall observability](https://easel.sh/docs/security/firewall-observability): Inspect firewall actions and understand why a request was allowed, blocked, or challenged.
- [Firewall](https://easel.sh/docs/security/firewall): Protect an Easel project with configurable request rules.
- [Security](https://easel.sh/docs/security): Understand how Easel protects deployments, traffic, workspaces, and application data.
- [IP rules](https://easel.sh/docs/security/ip-rules): Allow or block traffic using IP addresses in custom firewall rules.
- [Security limits](https://easel.sh/docs/security/limits): Reference limits for Easel firewall rules, Attack Mode, and related controls.
- [Platform protections](https://easel.sh/docs/security/platform-protections): Learn about the always-on protections Easel applies to incoming traffic.
- [Report a vulnerability](https://easel.sh/docs/security/report-a-vulnerability): Report a potential security issue affecting Easel.
- [Security evaluation order](https://easel.sh/docs/security/request-chain): Understand the order in which Easel evaluates security controls.
- [Secrets](https://easel.sh/docs/security/secrets): Store and use environment variables and credentials securely.
- [Security headers](https://easel.sh/docs/security/security-headers): Configure browser security policies for Easel applications.
- [Shared responsibility](https://easel.sh/docs/security/shared-responsibility): Understand which security responsibilities belong to Easel and which remain with your team.
- [Security troubleshooting](https://easel.sh/docs/security/troubleshooting): Diagnose blocked requests, Attack Mode failures, false positives, and firewall configuration problems.
- [WAF rules](https://easel.sh/docs/security/waf-rules): Match and act on requests with firewall, custom, and IP rules before application code runs.
- [Workspace security](https://easel.sh/docs/security/workspace-security): Control access to Easel projects, production changes, and sensitive settings.

## Agent access

- [MCP server](https://easel.sh/api/mcp): search and fetch docs from Cursor, Claude, and other MCP clients
- [llms-full.txt](https://easel.sh/llms-full.txt): full documentation as one Markdown file
- Markdown pages: append `.md` to any path under https://easel.sh/docs