Skip to main content

Walrus Sites (experimental, testnet only)

warning

Please note that Walrus is in active development, so some things can change or not work.

To deploy the frontend part of a Sui dApp Starter project to Sui through Walrus Sites, do the following:

Preparation​

1. Activate testnet network​

pnpm testnet:start

2. Install Walrus​

Follow the official Walrus setup guide - installation section.

3. Install Walrus Site Builder​

Follow the official Walrus Site Builder setup guide.

Deployment​

pnpm frontend:deploy:walrus

Configuration​

Walrus Sites configuration for the app is stored in packages/frontend/walrus-sites.yaml.

Current Limitations​

  1. Walrus Sites doesn't support the icons declared in the Web Manifest file.

  2. Walrus Sites doesn't support Service Workers in the root scope because it sets its own root-scoped service worker.

Troubleshooting​

  1. Can't find site-builder

If you installed site-builder, you need to add its path to PATH or add a symbolic link in ~/.local/bin/

  1. Walrus Site Builder can't find configuration

You probably need to add ~/.walrus/client_config.yaml config.

  1. TBC