Configure Environment

Add required and optional environment variables for MiniKit

Add required variables to your local and deployment environments.

Required Variables

These variables are essential for your MiniKit app to function:

NEXT_PUBLIC_ONCHAINKIT_PROJECT_NAME · string · required

The name of your Mini App as it appears to users

NEXT_PUBLIC_URL · string · required

The deployed URL of your application (must be HTTPS)

NEXT_PUBLIC_ONCHAINKIT_API_KEY · string · required

Your Coinbase Developer Platform API key

FARCASTER_HEADER · string · required

Generated during manifest creation for account association

FARCASTER_PAYLOAD · string · required

Generated during manifest creation for account association

FARCASTER_SIGNATURE · string · required

Generated during manifest creation for account association

Optional Variables

These variables enhance your app’s appearance and metadata:

NEXT_PUBLIC_APP_ICON · string

URL to your app’s icon (recommended: 48x48px PNG)

NEXT_PUBLIC_APP_SUBTITLE · string

Brief subtitle shown in app listings

NEXT_PUBLIC_APP_DESCRIPTION · string

Detailed description of your app’s functionality

NEXT_PUBLIC_APP_SPLASH_IMAGE · string

URL to splash screen image shown during app loading

NEXT_PUBLIC_SPLASH_BACKGROUND_COLOR · string

Hex color code for splash screen background (e.g., “#000000”)

NEXT_PUBLIC_APP_PRIMARY_CATEGORY · string

Primary category for app discovery (e.g., “social”, “gaming”, “utility”)

NEXT_PUBLIC_APP_HERO_IMAGE · string

Hero image URL displayed in cast previews

NEXT_PUBLIC_APP_TAGLINE · string

Short, compelling tagline for your app

NEXT_PUBLIC_APP_OG_TITLE · string

Open Graph title for social sharing

NEXT_PUBLIC_APP_OG_DESCRIPTION · string

Open Graph description for social sharing

NEXT_PUBLIC_APP_OG_IMAGE · string

Open Graph image URL for social media previews

Copy-paste .env example

Terminal

# Required
NEXT_PUBLIC_ONCHAINKIT_PROJECT_NAME=YourAppName
NEXT_PUBLIC_URL=https://your-app.vercel.app
NEXT_PUBLIC_ONCHAINKIT_API_KEY=your_cdp_client_api_key

# Generated by `npx create-onchain --manifest`
FARCASTER_HEADER=base64_header
FARCASTER_PAYLOAD=base64_payload
FARCASTER_SIGNATURE=hex_signature

# Optional (appearance and metadata)
NEXT_PUBLIC_APP_ICON=https://your-app.vercel.app/icon.png
NEXT_PUBLIC_APP_SUBTITLE=Short subtitle
NEXT_PUBLIC_APP_DESCRIPTION=Describe what your app does
NEXT_PUBLIC_APP_SPLASH_IMAGE=https://your-app.vercel.app/splash.png
NEXT_PUBLIC_SPLASH_BACKGROUND_COLOR=#000000
NEXT_PUBLIC_APP_PRIMARY_CATEGORY=social
NEXT_PUBLIC_APP_HERO_IMAGE=https://your-app.vercel.app/og.png
NEXT_PUBLIC_APP_TAGLINE=Play instantly
NEXT_PUBLIC_APP_OG_TITLE=Your App
NEXT_PUBLIC_APP_OG_DESCRIPTION=Fast, fun, social
NEXT_PUBLIC_APP_OG_IMAGE=https://your-app.vercel.app/og.png

Ensure all referenced assets are publicly accessible via HTTPS.