Party in the front, self custodial data in the back: self.surf allowlists apps to create new user accounts without having to redirect the user to self.surf.

Apps that use self.surf PDS must hide the .self.surf SLD.TLD domain ending. It is the apps responsibility to educate the user about the users account benefits at a later point in time.

The purpose is to make account signup as seamless as possible, since most people understand handles to be just an @username or /username without a .self.surf ending.

The self.surf landing page should be the most simple least technical explanation to what the benefits are for people.

setup#

prerequisites#

Node.js (v22+)
pnpm

installing#

clone the repo, copy .env.example to .env and edit it to your liking.

then, install dependencies:

pnpm install

development server#

local development server with hot reloading:

pnpm run dev

building#

to build the optimized bundle run:

pnpm run build

the output will be in the .svelte-kit/cloudflare/ directory.

deploying#

Cloudflare Pages (recommended)#

Push to GitHub/GitLab
Go to Cloudflare Dashboard → Pages → Create project
Connect your repo
Build settings:
- Build command: pnpm run build
- Output directory: .svelte-kit/cloudflare
Add environment variable: PUBLIC_PDS_URL with your PDS URL

Direct deploy with Wrangler#

pnpm add -D wrangler
npx wrangler pages deploy .svelte-kit/cloudflare

Set the PUBLIC_PDS_URL env var in Cloudflare dashboard after deploying.

configuring#

configuration is done via environment variables. copy .env.example to .env and edit:

PUBLIC_PDS_URL - your PDS base URL

theming#

edit src/lib/assets/theme.css to customize the appearance.

the favicon is located at static/favicon.ico

credits#

pds-dash & selfhosted.social.

license#

MIT

Clone this repository

self.surf#