relay

@farcaster/auth-relay

Farcaster Auth HTTP relay server.

Getting started

Install dependencies:

yarn install

Start a Redis container:

docker compose up

Run the server:

yarn start

About

The Farcaster Auth relay server connects apps and wallets over a temporary stateful channel. Channel sessions are stored in Redis and expire after 1 hour.

Anyone can run their own relay server and connect to it using the @farcaster/auth-client client. Merkle operates and maintains the relay.farcaster.xyz server used by Warpcast and available to the public.

You don't need to run a relay server to use Farcaster Auth. If you just want to sign in a user to your app, look at the @farcaster/auth-kit and @farcaster/auth-client packages.