Known restrictions
Walrus Sites can be used to deploy almost any form of traditional static web2 website build for modern browsers. There are, however, a number of restrictions that a developer should keep in mind when creating or porting a website to Walrus Sites.
No secret values
Walrus Sites are fully publicly accessible, as the metadata is stored on Sui, and the site content is stored on Walrus. Therefore, developers must not store secret values within the sites.
We emphasize again that any such backend-specific operations (storing secret values, authentication, etc.) are achievable by leveraging the integration with the Sui blockchain and a Sui-compatible wallet.
There is a maximum redirect depth
The number of consecutive redirects a Walrus Site can perform is capped by the Portal (see Portal configuration). This measure ensures that loading a Walrus Site does not result in an infinite loading loop.
Different Portals can set this limit as they desire. The limit for the Portal hosted at https://walrus.site has a maximum redirect depth of 3.
Service workers are not available
Walrus Sites leverage service workers in the clients' browsers to perform essential operations:
- reading the site metadata from Sui;
- fetching the page content from Walrus; and
- serving the content to the browser.
Therefore, a site deployed on Walrus Sites cannot use service workers itself. Installing a service worker from within a Walrus Site will result in a dysfunctional site and a poor experience for the user.
This limitation only applies to Portal based on service workers. A web Portal will not have this limitation.
iOS Sui mobile wallets do not work with Walrus Sites
Service workers cannot be loaded inside an in-app browser on iOS, because of a limitation of the WebKit engine. As a consequence, Walrus Sites cannot be used within Sui-compatible wallet apps on iOS. Therefore, Sui wallets cannot currently be used on a Walrus Site on iOS. Note, however, that browsing a Walrus Site is still possible on iOS through any browser. Only the connection to the wallet is impacted.
The connection with the Sui Wallet apps works on Android devices.
This limitation only applies to Portal based on service workers. A web Portal will not have this limitation.
No support for progressive web apps (PWAs)
With the current design, Walrus Sites cannot be used for progressive web apps (PWAs).
Two characteristics of the service-worker Portal prevent support for PWAs:
- Since the service worker needs to be registered for the page to work, the PWA's manifest file cannot be loaded by the browser directly.
- There can only be one service worker registered per origin. Therefore, registering a PWA's service worker would remove the Walrus Sites service worker, breaking Walrus Sites' functionality.
Note that the server-side Portal does not share these limitations. However, for the moment, we support both technologies: Walrus Sites must be able to load from both a service-worker Portal and a server-side Portal, and therefore have to be built with the more restrictive feature set. For more details, see the installation requirements for PWAs.