Walrus Sites
Walrus Sites are decentralized websites built on Sui and Walrus. Your site's files are stored on Walrus, a decentralized storage network, while a Sui smart contract records ownership and maps each resource path to its content. Anyone can publish a Walrus Site using the site-builder CLI tool and browse it through a portal.
Because there is no server behind a Walrus Site, no single host can take it offline, and no one but the wallet that owns the Sui site object can change it. The same absence of a server sets the limits: a Walrus Site serves static files only, so backends, databases, and server-side rendering are out of scope. Any framework that produces a static build works once you point site-builder at its output directory, and client-side routing works through the routes field in ws-resources.json.
Where to start
If you want to deploy something now, install the site-builder and follow Publishing Your First Site. The two together take you from an empty machine to a live site.
If you want to understand the system first, Technical Overview traces a single page load from the browser to Walrus, and Walrus Sites Components describes each moving part on its own.
If you already have a site running, Setting a SuiNS Name replaces the Base36 subdomain with a readable name, Site Configuration covers headers, routes, and metadata, and Creating a GitHub Actions Workflow redeploys the site on every push.
Before you commit to Walrus Sites for production, read Known Restrictions so the constraints are not a surprise later.
Technical Overview
Conceptual overview of how publishing, resolving, and serving a Walrus Site works end to end.
Walrus Sites Components
A Walrus Site consists of data stored as blobs on Walrus, a site object on Sui that maps resource paths to blob IDs, the site-builder CLI for publishing and updating, a ws-resources.json configuration file, and a portal that resolves and serves the site to browsers.
Getting Started
Site Configuration
Custom Domains
Walrus Portals
Linking and Navigation
CI/CD and Automation
Security and Authentication
Production Checklist
Take a Walrus Site from a local deploy to production, covering portal and network choice, SPA routing, caching and version pinning, SuiNS naming, and automated updates from CI.
Known Restrictions
A comprehensive reference of known restrictions and limitations when developing and deploying Walrus Sites.
Troubleshooting Walrus Sites
Solutions to common errors when deploying and browsing Walrus Sites.