Configuration & Customization

How to brand and configure your pleb.school instance using JSON config files.
Configuration & Customization

Configuration & Customization

pleb.school uses JSON configuration files in the config directory. These files are shipped to the client, so never put secrets there.

Config files overview

File Purpose
auth.json Auth providers, sign-in UI, copy
content.json Homepage sections, filters, search
copy.json User-facing text and navigation
theme.json Theme and font UI defaults
payments.json Zap presets and purchase UX
nostr.json Relay sets and publishing defaults
admin.json Admin and moderator pubkeys

Required environment variables

  • DATABASE_URL
  • NEXTAUTH_SECRET
  • NEXTAUTH_URL
  • PRIVKEY_ENCRYPTION_KEY

Tips for operators

  • Keep secrets in env vars, not config files
  • Use content.json to reshape the homepage without code
  • Use copy.json to localize or rebrand text quickly
  • Use nostr.json to control publishing and read relays

Config-first customization keeps the platform approachable for non-technical operators.


No comments yet.