Skip to content

Install and Self Hosting

José Carrillo edited this page Jun 13, 2026 · 2 revisions

Install and Self-Hosting

Zefer is a static, client-side web app. You can use it hosted, install it as a PWA, or self-host it. The /install page in the app summarizes all options.

Use it online (nothing to install)

Open https://zefer.carrillo.app. No account, no sign-up, no installation. Encryption happens in your browser.

Install as a PWA

Zefer is a Progressive Web App with an offline-capable service worker. Install it from your browser to get an app-like, standalone experience:

  • Chrome / Edge: open the site → menu (⋮) → Install app / Add to Home screen.
  • Safari (iOS / macOS): ShareAdd to Home Screen.
  • Firefox (Android): menu (⋮) → Install.

The service worker caches all pages and static assets and is registered only in production, so the installed app keeps working offline. Network-first for pages (fresh when online, cached when offline); cache-first for static assets.

Command line

For terminals, scripts, and automation, use the official CLI (zefer-cli) — same format, same crypto. Install via npm, run via npx, or download a standalone binary.

Self-host

Zefer is a standard Next.js 16 app. To run your own instance:

git clone https://github.com/carrilloapps/zefer.git
cd zefer
npm install
npm run build
npm run start        # serves the production build

For development:

npm run dev          # http://localhost:3000

Because the app is client-side, you can deploy the production build to any static-friendly host or Node host (Vercel, Netlify, a container, your own server). There is no backend to operate; the only dynamic route is /api/author (cached GitHub profile data for the project page). See Architecture and Tech Stack and the repository docs/DEPLOYMENT.md for details.

Native apps

Native desktop/mobile builds are noted as coming soon on the install page; until then, the PWA install gives an app-like experience on every platform.


📖 Glossary — terms on this page: PWA · client-side · zero-knowledge. Full list in the Glossary.

Clone this wiki locally