Documentation

Setup, configuration, and integration guides for Slash Socket.

Getting Started

One JSON manifest in, a real-time server out — on your Mac or your own host.

Download Slash Socket and run your first socket.

What the app shows you while the server is running.

Sockets

Every key a socket manifest takes.

value, counter, list, map, stream and presence — what each holds and what pages can do with it.

The small type language that says what a field's values look like.

Access & Tokens

Who can read and write each field, and signing visitors in with your own backend.

Paste one file into an LLM and it writes your manifest, page code and deploy recipe.

Client

Connect a page to a socket and read and write its fields.

A useField hook, a chat, and live cursors that don't re-render.

Write fields from your backend, moderate, and push manifests — with the admin key.

Deploy

Run a socket from the Slash Socket app — great for development and small live sites.

Reaching the internet

Two ways visitors get to your Mac: a Cloudflare tunnel that opens nothing, or forwarding a port on your router.

slash-socket-server as a container — the base for every other recipe.

A socket on Fly.io with a volume and your own domain.

A socket on Railway from the published image.

A socket on Render as a web service with a disk.

Any Linux server with Docker: the socket behind Caddy, with automatic HTTPS.

Point your own domain at your socket, wherever it runs.

Configuring the App

Change the port the server listens on.

Restrict origins, cap connections, rate-limit, and ban IPs.

Publish Slash Socket on your own domain — connect Vercel on slash.tools and Socket keeps it on your public IP.

Socket.IO (classic)

Connect a Socket.IO client to your running server.

A live multiplayer cursors demo, with the complete code behind it.

Next.js Example

Build live multiplayer cursors in a Next.js app, end to end.

Events Reference

Every event the server emits and listens for.