Introduction

HappyView is an open-source AppView for atproto. It indexes records from the atproto network and serves an XRPC API over them. Lexicons define the record collections it indexes and the API’s endpoints. Scripts define what each endpoint does and what happens when a record changes.

A HappyView instance also signs users in with atproto OAuth and writes records to their PDSes on their behalf.

HappyView v3 is in alpha. These docs describe v3. The v2 docs cover instances still on v2.

Where to start

Build an appGetting started, in order, from the atproto terms these docs use through to deploying.

Run your own instanceSelf-hosting: Docker, the release binaries and production setup.

Use HappyProtoHappyProto hosts HappyView instances. A project deploys to the instance in a HappyProto project.