Skip to content

Docs: Run Your Own Superhero, a self-hosting guide for the full stack - #4

Open
Jeanclaudeaoun wants to merge 1 commit into
mainfrom
claude/self-hosting-guide
Open

Jeanclaudeaoun wants to merge 1 commit into
mainfrom
claude/self-hosting-guide

Conversation

@Jeanclaudeaoun

Copy link
Copy Markdown
Contributor

What this adds

A new section under Build, Run Your Own Superhero, that walks an operator through every service behind superhero.com, in the order to bring them up:

Page Covers
Overview The moving parts (diagram), two ways to run it (own front end on the shared API, or the full stack), bring-up order, what to expect
Node, Middleware & Compiler ae_mdw from snapshots, the paths the API reads, reverse-proxy layout, where the endpoints are set, the compiler, the explorer
API & Indexer Build (Docker secret or plain npm), configuration, first-time database setup, indexing progress and health, after-downtime recovery, HTTP surface
Charts & History Every chart and where it comes from: computed on read vs rebuilt on a schedule, AE price data from CoinGecko, how fiat values are stored, how a new instance fills in
Web App Build- and run-time settings, the compiled network block, Docker, CSP, passkeys and domain-bound features, charts
Chat Relay groups_relay, TLS with automatic renewal, the admin key shared with the API (TG_RELAY_URL, TG_BOT_NSEC), pointing the app at it
Governance Backend Running governance-server, its settings and routes, pointing the clients at it
Contracts Public or your own, per contract family, and where each address is set in the API, web app and agent skill
Keys & Integrations X, rewards wallets, .chain sponsoring, web/mobile push, GIFs, trending tags, affiliation sign-in, the agent skill
Operations TLS certificates, health checks, backups, upgrades, scaling, security and launch checklists

Only new files plus one line in pages/_meta.json, so it is independent of #3.

How it was checked

  • Every setting, path and endpoint was read from the code on main of superhero, superhero-api, aepp-governance, ae_mdw, groups_relay and the contract repositories.
  • Database setup was run end to end against superhero-api main on PostgreSQL 16 and Redis: the three documented steps build the schema, record the ten migrations the entities already cover, apply the other 28 on start, and the API comes up with live sync active, the backfill running and posts served within seconds.
  • python3 scripts/lint-mdx.py: 0 issues across 162 pages. npm run build: all ten pages render.

Things to confirm

  • AddressLink. The Contracts page says the Superhero team provides the AddressLink contract on request, because its source isn't in a public repository. Confirm that's how we want to handle it, or we publish the contract.
  • Follow-ups that would shorten the guide (separate PRs, not in this one):
    • superhero-api: a baseline migration so a new database needs only the normal start. This is a database change, so dev environment first and with your approval.
    • superhero-api and superhero: environment variables for the node, middleware and compiler URLs, which are set in code today.
    • Both repos still point at the v7 compiler; the guide recommends v8 for deployments.
    • Agent skill: environment variables for its API, node and contract constants.

Generated by Claude Code

…tack

A new section under Build that walks an operator through every service
behind superhero.com:

- Node, middleware and compiler: ae_mdw from snapshots, the paths the
  API reads, and where the endpoints are set.
- API and indexer: build, configuration, first-time database setup
  (tested on PostgreSQL 16 against superhero-api main), indexing progress
  and the HTTP surface.
- Charts and history: which charts are computed on read, which are
  rebuilt on a schedule, AE price data, and how a new instance fills in.
- Web app: build- and run-time settings, the CSP, passkeys and the
  domain-bound features.
- Chat relay: groups_relay, TLS, the admin key shared with the API.
- Governance backend, contracts (public or your own), keys and
  integrations, and operations with a launch checklist.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants