+server

// pages/+config.js
 
export default {
  server: true // Use Vike's built-in server
}

// pages/+config.ts
 
export default {
  server: true // Use Vike's built-in server
}

// +server.js
 
export default {
  // Production settings
  prod: {
    // Server port, defaults to 3000. It's ignored on Cloudflare and Vercel Edge (there
    // isn't any server in serverless deployments).
    port: 3000,
 
    hostname: 'localhost',
 
    // Called once the server is accepting connections.
    // - The `server` object comes from srvx, see https://srvx.h3.dev/guide/server
    // - This hook isn't called on Cloudflare and Vercel Edge (there isn't
    //   any server in serverless deployments).
    onReady(server) {
      console.log('Server is ready.')
    },
 
    // Called once the server is created.
    // - The `server` object comes from srvx, see https://srvx.h3.dev/guide/server
    // - This hook isn't called on Cloudflare and Vercel Edge (there isn't
    //   any server in serverless deployments).
    onCreate(server) {
      console.log('Server created.')
    },
 
    // HTTPS Options (Node.js/Bun/Deno)
    tls: {
      // For example SSL/TLS key and certificate for HTTPS
      key: fs.readFileSync('/etc/letsencrypt/live/example.com/privkey.pem'),
      cert: fs.readFileSync('/etc/letsencrypt/live/example.com/fullchain.pem'),
      // Optional
      passphrase: 'passphrase'
    },
 
    // Serve static files automatically
    static: true, // Default value
    // Can be disabled:
    static: false,
    // Or serve from a custom folder:
    static: './public'
  }
}

// +server.ts
 
import type { Server } from 'vike/types'
 
export default {
  // Production settings
  prod: { 
    // Server port, defaults to 3000. It's ignored on Cloudflare and Vercel Edge (there
    // isn't any server in serverless deployments).
    port: 3000,
 
    hostname: 'localhost',
 
    // Called once the server is accepting connections.
    // - The `server` object comes from srvx, see https://srvx.h3.dev/guide/server
    // - This hook isn't called on Cloudflare and Vercel Edge (there isn't
    //   any server in serverless deployments).
    onReady(server) {
      console.log('Server is ready.')
    },
 
    // Called once the server is created.
    // - The `server` object comes from srvx, see https://srvx.h3.dev/guide/server
    // - This hook isn't called on Cloudflare and Vercel Edge (there isn't
    //   any server in serverless deployments).
    onCreate(server) {
      console.log('Server created.')
    },
 
    // HTTPS Options (Node.js/Bun/Deno)
    tls: {
      // For example SSL/TLS key and certificate for HTTPS
      key: fs.readFileSync('/etc/letsencrypt/live/example.com/privkey.pem'),
      cert: fs.readFileSync('/etc/letsencrypt/live/example.com/fullchain.pem'),
      // Optional
      passphrase: 'passphrase'
    },
 
    // Serve static files automatically
    static: true, // Default value
    // Can be disabled:
    static: false,
    // Or serve from a custom folder:
    static: './public'
  }
} satisfies Server

// pages/product/@id/+data.js
 
export async function data(pageContext) {
  // Using pageContext.req to access the logged-in user
  const { user } = pageContext.req
  // ...
}

// pages/product/@id/+data.ts
 
import type { PageContextServer } from 'vike/types'
 
export type Data = Awaited<ReturnType<typeof data>>
export async function data(pageContext: PageContextServer) {
  // Using pageContext.req to access the logged-in user
  const { user } = pageContext.req
  // ...
}
 
declare global {
  namespace Vike {
    interface Server {
      // 👉 Pick your server (for correct pageContext.req/pageContext.res type)
      server: 'hono' // | 'express' | 'fastify' | 'h3' | 'elysia'
    }
  }
}

// vite.config.js
 
import { defineConfig } from 'vite'
import standaloner from 'standaloner/vite'
 
export default defineConfig({
  plugins: [
    standaloner() 
  ]
})

// vite.config.ts
 
import { defineConfig } from 'vite'
import standaloner from 'standaloner/vite'
 
export default defineConfig({
  plugins: [
    standaloner() 
  ]
})

// server/websocket.js
 
import { defineHooks } from 'crossws'
 
export const websocket = defineHooks({
  upgrade(request) {
    // Only accept WebSocket connections to /ws
    if (new URL(request.url).pathname !== '/ws') throw new Response('Not Found', { status: 404 })
  },
  message(peer, message) {
    peer.send(`echo: ${message.text()}`)
  }
})

// server/websocket.ts
 
import { defineHooks } from 'crossws'
 
export const websocket = defineHooks({
  upgrade(request) {
    // Only accept WebSocket connections to /ws
    if (new URL(request.url).pathname !== '/ws') throw new Response('Not Found', { status: 404 })
  },
  message(peer, message) {
    peer.send(`echo: ${message.text()}`)
  }
})

// +server.js
 
import { plugin as ws } from 'crossws/server'
import { websocket } from './server/websocket'
 
// ...
 
export default {
  fetch: app.fetch,
  prod: {
    // Production
    plugins: [ws(websocket)]
  }
}

// +server.ts
 
import { plugin as ws } from 'crossws/server'
import { websocket } from './server/websocket'
import type { Server } from 'vike/types'
 
// ...
 
export default {
  fetch: app.fetch,
  prod: {
    // Production
    plugins: [ws(websocket)]
  }
} satisfies Server

// vite.config.js
 
import vike from 'vike/plugin'
import crossws from 'crossws/adapters/node'
 
export default {
  plugins: [vike(), websocketDev()]
}
 
// Development
function websocketDev() {
  return {
    name: 'websocket-dev',
    configureServer(server) {
      const ws = crossws({
        resolve: async () => {
          const { runner } = server.environments.ssr
          return (await runner.import('/server/websocket.js')).websocket
        }
      })
      server.httpServer?.on('upgrade', (req, socket, head) => {
        // Vite's HMR WebSocket
        if (req.headers['sec-websocket-protocol'] === 'vite-hmr') return
        ws.handleUpgrade(req, socket, head)
      })
    }
  }
}

// vite.config.ts
 
import vike from 'vike/plugin'
import crossws from 'crossws/adapters/node'
import type { Plugin, RunnableDevEnvironment } from 'vite'
 
export default {
  plugins: [vike(), websocketDev()]
}
 
// Development
function websocketDev(): Plugin {
  return {
    name: 'websocket-dev',
    configureServer(server) {
      const ws = crossws({
        resolve: async () => {
          const { runner } = server.environments.ssr as RunnableDevEnvironment
          return (await runner.import('/server/websocket.ts')).websocket
        }
      })
      server.httpServer?.on('upgrade', (req, socket, head) => {
        // Vite's HMR WebSocket
        if (req.headers['sec-websocket-protocol'] === 'vite-hmr') return
        ws.handleUpgrade(req, socket, head)
      })
    }
  }
}