TanStack
Start v0v0
Documentation
Framework
Version
Menu
Getting Started
Examples

Hosting

Hosting is the process of deploying your application to the internet so that users can access it. This is a critical part of any web development project, ensuring your application is available to the world. TanStack Start is built on Vite, a powerful dev/build platform that allows us to make it possible to deploy your application to any hosting provider.

What should I use?

TanStack Start is designed to work with any hosting provider, so if you already have a hosting provider in mind, you can deploy your application there using the full-stack APIs provided by TanStack Start.

However, since hosting is one of the most crucial aspects of your application's performance, reliability, and scalability, we recommend using one of our Official Hosting Partners: Cloudflare or Netlify.

Deployment

Warning

The page is still a work in progress. We'll keep updating this page with guides on deployment to different hosting providers soon!

Once you've chosen a deployment target, you can follow the deployment guidelines below to deploy your TanStack Start application to the hosting provider of your choice:

Cloudflare Workers ā­ Official Partner

 Cloudflare logo

Cloudflare Workers

When deploying to Cloudflare Workers, you'll need to complete a few extra steps before your users can start using your app.

  1. Install @cloudflare/vite-plugin
pnpm install @cloudflare/vite-plugin -D

pnpm install @cloudflare/vite-plugin -D
  1. Update vite.config.ts

Add the cloudflare plugin to your vite.config.ts file.

// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import { cloudflare } from '@cloudflare/vite-plugin'
import viteSolidJS from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [
    cloudflare({ viteEnvironment: { name: 'ssr' } }),
    tanstackStart(),
    viteSolidJS(),
  ],
})

// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import { cloudflare } from '@cloudflare/vite-plugin'
import viteSolidJS from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [
    cloudflare({ viteEnvironment: { name: 'ssr' } }),
    tanstackStart(),
    viteSolidJS(),
  ],
})
  1. Install wrangler
pnpm add wrangler -D

pnpm add wrangler -D
  1. Add a wrangler.json config file
{
  "$schema": "node_modules/wrangler/config-schema.json",
  "name": "tanstack-start-app",
  "compatibility_date": "2025-09-02",
  "compatibility_flags": ["nodejs_compat"],
  "main": "@tanstack/solid-start/server-entry",
  "vars": {
    "MY_VAR": "Hello from Cloudflare"
  }
}

{
  "$schema": "node_modules/wrangler/config-schema.json",
  "name": "tanstack-start-app",
  "compatibility_date": "2025-09-02",
  "compatibility_flags": ["nodejs_compat"],
  "main": "@tanstack/solid-start/server-entry",
  "vars": {
    "MY_VAR": "Hello from Cloudflare"
  }
}
  1. Modify package.json script
{
  "scripts": {
    "dev": "vite dev",
    "build": "vite build && tsc --noEmit",
    "start": "node .output/server/index.mjs",
    // ============ šŸ‘‡ add this line ============
    "deploy": "wrangler deploy"
  }
}

{
  "scripts": {
    "dev": "vite dev",
    "build": "vite build && tsc --noEmit",
    "start": "node .output/server/index.mjs",
    // ============ šŸ‘‡ add this line ============
    "deploy": "wrangler deploy"
  }
}
  1. Build and deploy
pnpm run build && pnpm run deploy

pnpm run build && pnpm run deploy

Deploy your application to Cloudflare Workers using their one-click deployment process, and you're ready to go!

A full TanStack Start example for Cloudflare Workers is available here.

Netlify ā­ Official Partner

 Netlify logo

Netlify

Install and add the @netlify/vite-plugin-tanstack-start plugin, which configures your build for Netlify deployment and provides full Netlify production platform emulation in local dev.

// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import netlify from '@netlify/vite-plugin-tanstack-start'
import viteSolidJS from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [tanstackStart(), netlify(), viteSolidJS()],
})

// vite.config.ts
import { defineConfig } from 'vite'
import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import netlify from '@netlify/vite-plugin-tanstack-start'
import viteSolidJS from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [tanstackStart(), netlify(), viteSolidJS()],
})

Add a netlify.toml file to your project root:

[build]
  command = "vite build"
  publish = "dist/client"

[build]
  command = "vite build"
  publish = "dist/client"

Deploy your application using their one-click deployment process, and you're ready to go!

Nitro

Nitro is an abstraction layer that allows you to deploy TanStack Start applications to a wide range of providers.

āš ļø During TanStack Start 1.0 release candidate phase, we currently recommend using:

Using Nitro v2

āš ļø @tanstack/nitro-v2-vite-plugin is a temporary compatibility plugin for using Nitro v2 as the underlying build tool for TanStack Start. Use this plugin if you experience issues with the Nitro v3 plugin. It does not support all of Nitro v3's features and is limited in its dev server capabilities, but should work as a safe fallback, even for production deployments for those who were using TanStack Start's alpha/beta versions.

import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import { defineConfig } from 'vite'
import viteSolidJS from '@vitejs/plugin-react'
import { nitroV2Plugin } from '@tanstack/nitro-v2-vite-plugin'

export default defineConfig({
  plugins: [
    tanstackStart(),
    nitroV2Plugin(/* 
      // nitro config goes here, e.g.
      { preset: 'node-server' }
    */),
    viteSolidJS(),
  ],
})

import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import { defineConfig } from 'vite'
import viteSolidJS from '@vitejs/plugin-react'
import { nitroV2Plugin } from '@tanstack/nitro-v2-vite-plugin'

export default defineConfig({
  plugins: [
    tanstackStart(),
    nitroV2Plugin(/* 
      // nitro config goes here, e.g.
      { preset: 'node-server' }
    */),
    viteSolidJS(),
  ],
})

Using Nitro v3 (BETA)

āš ļø The nitro vite plugin is an official BETA plugin from the Nitro team for using Nitro v3 as the underlying build tool for TanStack Start. It is still in development and is receiving regular updates.

This package needs to be installed as follows:

 "nitro": "npm:nitro-nightly",

 "nitro": "npm:nitro-nightly",

import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import { defineConfig } from 'vite'
import viteSolidJS from '@vitejs/plugin-react'
import { nitro } from 'nitro/vite'

export default defineConfig({
  plugins: [
    tanstackStart(),
    nitro(/*
      // nitro config goes here, e.g.
      { config: { preset: 'node-server' } }
    */)
    viteSolidJS(),
  ],
})

import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import { defineConfig } from 'vite'
import viteSolidJS from '@vitejs/plugin-react'
import { nitro } from 'nitro/vite'

export default defineConfig({
  plugins: [
    tanstackStart(),
    nitro(/*
      // nitro config goes here, e.g.
      { config: { preset: 'node-server' } }
    */)
    viteSolidJS(),
  ],
})

Vercel

Follow the Nitro deployment instructions. Deploy your application to Vercel using their one-click deployment process, and you're ready to go!

Node.js / Railway / Docker

Follow the Nitro deployment instructions. Use the node command to start your application from the server from the build output files.

Ensure build and start npm scripts are present in your package.json file:

    "build": "vite build",
    "start": "node .output/server/index.mjs"

    "build": "vite build",
    "start": "node .output/server/index.mjs"

Then you can run the following command to build your application:

npm run build

npm run build

You can start your application by running:

npm run start

npm run start

Bun

Important

Currently, the Bun specific deployment guidelines only work with SolidJS 19. If you are using SolidJS 18, please refer to the Node.js deployment guidelines.

Make sure that your react and react-dom packages are set to version 19.0.0 or higher in your package.json file. If not, run the following command to upgrade the packages:

bun install react@19 react-dom@19

bun install react@19 react-dom@19

Follow the Nitro deployment instructions. Depending on how you invoke the build, you might need to set the 'bun' preset in the Nitro configuration:

// vite.config.ts
import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import { defineConfig } from 'vite'
import viteSolidJS from '@vitejs/plugin-react'
import { nitroV2Plugin } from '@tanstack/nitro-v2-vite-plugin'
// alternatively: import { nitro } from 'nitro/vite'

export default defineConfig({
  plugins: [
    tanstackStart(),
    nitroV2Plugin({ preset: 'bun' })
    // alternatively: nitro( { config: { preset: 'bun' }} ),
    viteSolidJS(),
  ],
})

// vite.config.ts
import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import { defineConfig } from 'vite'
import viteSolidJS from '@vitejs/plugin-react'
import { nitroV2Plugin } from '@tanstack/nitro-v2-vite-plugin'
// alternatively: import { nitro } from 'nitro/vite'

export default defineConfig({
  plugins: [
    tanstackStart(),
    nitroV2Plugin({ preset: 'bun' })
    // alternatively: nitro( { config: { preset: 'bun' }} ),
    viteSolidJS(),
  ],
})

Production Server with Bun

Alternatively, you can use a custom server implementation that leverages Bun's native APIs.

We provide a reference implementation that demonstrates one approach to building a production-ready Bun server. This example uses Bun-native functions for optimal performance and includes features like intelligent asset preloading and memory management.

This is a starting point - feel free to adapt it to your needs or simplify it for your use case.

What this example demonstrates:

  • Serving static assets using Bun's native file handling
  • Hybrid loading strategy (preload small files, serve large files on-demand)
  • Optional features like ETag support and Gzip compression
  • Production-ready caching headers

Quick Setup:

  1. Copy the server.ts file from the example repository to your project root (or use it as inspiration for your own implementation)

  2. Build your application:

    bun run build

    bun run build

  3. Start the server:

    bun run server.ts

    bun run server.ts

Configuration (Optional):

The reference server implementation includes several optional configuration options via environment variables. You can use these as-is, modify them, or remove features you don't need:

# Basic usage - just works out of the box
bun run server.ts

# Common configurations
PORT=8080 bun run server.ts  # Custom port
ASSET_PRELOAD_VERBOSE_LOGGING=true bun run server.ts  # See what's happening

# Basic usage - just works out of the box
bun run server.ts

# Common configurations
PORT=8080 bun run server.ts  # Custom port
ASSET_PRELOAD_VERBOSE_LOGGING=true bun run server.ts  # See what's happening

Available Environment Variables:

VariableDescriptionDefault
PORTServer port3000
ASSET_PRELOAD_MAX_SIZEMaximum file size to preload into memory (bytes)5242880 (5MB)
ASSET_PRELOAD_INCLUDE_PATTERNSComma-separated glob patterns for files to includeAll files
ASSET_PRELOAD_EXCLUDE_PATTERNSComma-separated glob patterns for files to excludeNone
ASSET_PRELOAD_VERBOSE_LOGGINGEnable detailed loggingfalse
ASSET_PRELOAD_ENABLE_ETAGEnable ETag generationtrue
ASSET_PRELOAD_ENABLE_GZIPEnable Gzip compressiontrue
ASSET_PRELOAD_GZIP_MIN_SIZEMinimum file size for Gzip (bytes)1024 (1KB)
ASSET_PRELOAD_GZIP_MIME_TYPESMIME types eligible for Gziptext/,application/javascript,application/json,application/xml,image/svg+xml
Advanced configuration examples 
# Optimize for minimal memory usage
ASSET_PRELOAD_MAX_SIZE=1048576 bun run server.ts

# Preload only critical assets
ASSET_PRELOAD_INCLUDE_PATTERNS="*.js,*.css" \
ASSET_PRELOAD_EXCLUDE_PATTERNS="*.map,vendor-*" \
bun run server.ts

# Disable optional features
ASSET_PRELOAD_ENABLE_ETAG=false \
ASSET_PRELOAD_ENABLE_GZIP=false \
bun run server.ts

# Custom Gzip configuration
ASSET_PRELOAD_GZIP_MIN_SIZE=2048 \
ASSET_PRELOAD_GZIP_MIME_TYPES="text/,application/javascript,application/json" \
bun run server.ts

# Optimize for minimal memory usage
ASSET_PRELOAD_MAX_SIZE=1048576 bun run server.ts

# Preload only critical assets
ASSET_PRELOAD_INCLUDE_PATTERNS="*.js,*.css" \
ASSET_PRELOAD_EXCLUDE_PATTERNS="*.map,vendor-*" \
bun run server.ts

# Disable optional features
ASSET_PRELOAD_ENABLE_ETAG=false \
ASSET_PRELOAD_ENABLE_GZIP=false \
bun run server.ts

# Custom Gzip configuration
ASSET_PRELOAD_GZIP_MIN_SIZE=2048 \
ASSET_PRELOAD_GZIP_MIME_TYPES="text/,application/javascript,application/json" \
bun run server.ts

Example Output:

šŸ“¦ Loading static assets from ./dist/client...
   Max preload size: 5.00 MB

šŸ“ Preloaded into memory:
   /assets/index-a1b2c3d4.js           45.23 kB ā”‚ gzip:  15.83 kB
   /assets/index-e5f6g7h8.css           12.45 kB ā”‚ gzip:   4.36 kB

šŸ’¾ Served on-demand:
   /assets/vendor-i9j0k1l2.js          245.67 kB ā”‚ gzip:  86.98 kB

āœ… Preloaded 2 files (57.68 KB) into memory
šŸš€ Server running at http://localhost:3000

šŸ“¦ Loading static assets from ./dist/client...
   Max preload size: 5.00 MB

šŸ“ Preloaded into memory:
   /assets/index-a1b2c3d4.js           45.23 kB ā”‚ gzip:  15.83 kB
   /assets/index-e5f6g7h8.css           12.45 kB ā”‚ gzip:   4.36 kB

šŸ’¾ Served on-demand:
   /assets/vendor-i9j0k1l2.js          245.67 kB ā”‚ gzip:  86.98 kB

āœ… Preloaded 2 files (57.68 KB) into memory
šŸš€ Server running at http://localhost:3000

For a complete working example, check out the TanStack Start + Bun example in this repository.

Edit on GitHub
Client Entry Point
Authentication Overview
Partners
Code Rabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
Sentry
Prisma
Strapi
Unkey
Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.