The Walrus Sites Portal
We use the term "Portal" to indicate any technology that is used to access an browse Walrus Sites. As mentioned in the overview, we foresee three kinds of Portals:
- server-side Portals;
- custom local apps; and
- service-worker based Portals in the browser.
Currently, only the service-worker based Portal is available.
Running the Portal locally
You can run a service-worker Portal locally if you want to browse Walrus Sites without accessing external Portals or for development purposes.
This requires having the pnpm
tool installed. To start, clone the
walrus-sites
repo and enter the portal
directory. Here, run
pnpm install
to install the dependencies, and
pnpm serve
to serve the Portal. Typically, you will find it served at localhost:8080
(but check the output of
the serve command).
Configuring the Portal
The most important configuration parameters for the Portal are in constants.ts
:
NETWORK
: The Sui network to be used for fetching the Walrus Sites objects. Currently, we use Suitestnet
.AGGREGATOR
: The URL of the aggregator from which the service worker will fetch the Walrus blobs.SITE_PACKAGE
: The Sui object ID of the Walrus Sites package.MAX_REDIRECT_DEPTH
: The number of redirects the service worker will follow before stopping.SITE_NAMES
: Hard codedname: objectID
mappings, to override the SuiNS names. For development only.