Configuration

API Server

The following are the detailed configurations for the API server. You can inject these environment variables into the refly_api container.

General Config

Env	Description	Default Value
NODE_ENV	Node environment	development
PORT	HTTP API service port, used for regular API requests	5800
WS_PORT	WebSocket server port, used for real-time synchronization for canvases and documents	5801
ORIGIN	Client origin (where you are accessing the Refly application from), used for CORS check	http://localhost:5700
STATIC_PUBLIC_ENDPOINT	Public static file endpoint (which can be accessed without authentication)	http://localhost:5800/v1/misc/public
STATIC_PRIVATE_ENDPOINT	Private static file endpoint (which must be accessed with authentication)	http://localhost:5800/v1/misc

Middlewares

Refly depends on following middlewares to function properly:

• Postgres: used for basic data persistence
• Redis: used for cache, asynchronous task queue and coordination within distributed environment
• Qdrant: used for semantic searching via embeddings
• MinIO: used for object storage for canvas, document and resource data

Optional:

• SearXNG: used for online searching
• Elasticsearch: used for full-text searching within workspace

Postgres

Env	Description	Default Value
DATABASE_URL	PostgreSQL connection URL	postgresql://refly:test@localhost:5432/refly?schema=refly

INFO

Refer to Prisma doc for detailed definition of connection URL.

Redis

Env	Description	Default Value
REDIS_HOST	Redis host	localhost
REDIS_PORT	Redis port	6379
REDIS_USERNAME	Redis username	(not set)
REDIS_PASSWORD	Redis password	(not set)

Vector Store

Env	Description	Default Value
VECTOR_STORE_BACKEND	Vector store backend (qdrant or lancedb)	qdrant

Qdrant (Vector Store)

Env	Description	Default Value
QDRANT_HOST	Qdrant host	localhost
QDRANT_PORT	Qdrant port	6333
QDRANT_API_KEY	Qdrant API key	(not set)

LanceDB (Vector Store)

Env	Description	Default Value
LANCEDB_URI	LanceDB database URI	./data/lancedb

Object Storage

Env	Description	Default Value
OBJECT_STORAGE_RECLAIM_POLICY	Object storage reclaim policy (retain or delete)	retain
OBJECT_STORAGE_BACKEND	Object storage backend (minio or fs)	minio

File System Storage

Env	Description	Default Value
OBJECT_STORAGE_FS_ROOT	File system storage root path	./storage

MinIO

Refly requires two MinIO instances:

• Internal: used for storing canvas, resource, and document data, typically with visibility set to private.
• External: used for storing uploaded files, typically with visibility set to public.

Env	Description	Default Value
MINIO_INTERNAL_ENDPOINT	MinIO host used for internal data	localhost
MINIO_INTERNAL_PORT	MinIO port used for internal data	9000
MINIO_INTERNAL_USE_SSL	Whether to use HTTPS for transport	false
MINIO_INTERNAL_ACCESS_KEY	Access key for internal MinIO	minioadmin
MINIO_INTERNAL_SECRET_KEY	Secret key for MinIO	minioadmin
MINIO_INTERNAL_BUCKET	Bucket name for internal	refly-weblink
MINIO_EXTERNAL_ENDPOINT	MinIO host used for external data	localhost
MINIO_EXTERNAL_PORT	MinIO port used for external data	9000
MINIO_EXTERNAL_USE_SSL	Whether to use HTTPS for transport	false
MINIO_EXTERNAL_ACCESS_KEY	Access key for external MinIO	minioadmin
MINIO_EXTERNAL_SECRET_KEY	Secret key for MinIO	minioadmin
MINIO_EXTERNAL_BUCKET	Bucket name for external	refly-weblink

Full-Text Search

Env	Description	Default Value
FULLTEXT_SEARCH_BACKEND	Full-text search backend (prisma or elasticsearch)	prisma
ELASTICSEARCH_URL	Elasticsearch URL (required if FULLTEXT_SEARCH_BACKEND is elasticsearch)	http://localhost:9200
ELASTICSEARCH_USERNAME	Elasticsearch username (required if FULLTEXT_SEARCH_BACKEND is elasticsearch)	(not set)
ELASTICSEARCH_PASSWORD	Elasticsearch password (required if FULLTEXT_SEARCH_BACKEND is elasticsearch)	(not set)

Authentication Configuration

Env	Description	Default Value
AUTH_SKIP_VERIFICATION	Whether to skip email verification	false
LOGIN_REDIRECT_URL	URL to redirect after OAuth login	(not set)
JWT_SECRET	JWT signing secret	test
JWT_EXPIRATION_TIME	JWT access token expiration time	1h
JWT_REFRESH_EXPIRATION_TIME	JWT refresh token expiration time	7d
COLLAB_TOKEN_EXPIRY	Collaboration token expiration time	1h

Cookie Configuration

Env	Description	Default Value
REFLY_COOKIE_DOMAIN	Cookie domain used for signing authentication tokens	(not set)
REFLY_COOKIE_SECURE	Whether to use secure cookies	(not set)
REFLY_COOKIE_SAME_SITE	SameSite cookie attribute	(not set)

INFO

The time format is compatible with Vercel MS.

Email Authentication

Env	Description	Default Value
EMAIL_AUTH_ENABLED	Whether to enable email authentication	true
EMAIL_SENDER	Email sender	Refly <[email protected]>
RESEND_API_KEY	Resend API key, used for sending emails	re_123

WARNING

The default RESEND_API_KEY is invalid (just a placeholder). Please set your own API key if needed.

GitHub Authentication

Env	Description	Default Value
GITHUB_AUTH_ENABLED	Whether to enable GitHub authentication	false
GITHUB_CLIENT_ID	GitHub OAuth client ID	test
GITHUB_CLIENT_SECRET	GitHub OAuth client secret	test
GITHUB_CALLBACK_URL	GitHub OAuth callback URL	test

WARNING

The default OAuth credentials are invalid (just a placeholder). Please set your own GitHub OAuth credentials if needed.

INFO

You can learn more about GitHub OAuth at GitHub Developer.

Google Authentication

Env	Description	Default Value
GOOGLE_AUTH_ENABLED	Whether to enable Google authentication	false
GOOGLE_CLIENT_ID	Google OAuth client ID	test
GOOGLE_CLIENT_SECRET	Google OAuth client secret	test
GOOGLE_CALLBACK_URL	Google OAuth callback URL	test

WARNING

The default OAuth credentials are invalid (just a placeholder). Please set your own Google OAuth credentials if needed.

INFO

You can learn more about Google OAuth at Google Developer.

Image Processing

Env	Description	Default Value
IMAGE_MAX_AREA	Maximum area of images passed to LLM	360000
IMAGE_PAYLOAD_MODE	Image payload mode (base64 or url)	base64
IMAGE_PRESIGN_EXPIRY	Expiry time (in seconds) for presigned image URLs	900

Encryption

Env	Description	Default Value
ENCRYPTION_KEY	Encryption key used for encrypting and decrypting sensitive data	(not set)

Skill Execution

Env	Description	Default Value
SKILL_STREAM_IDLE_TIMEOUT	Skill stream idle timeout in milliseconds	0
SKILL_STREAM_IDLE_CHECK_INTERVAL	Skill stream idle check interval in milliseconds	3000
SKILL_STUCK_CHECK_INTERVAL	Skill stuck check interval in milliseconds	0
SKILL_STUCK_TIMEOUT_THRESHOLD	Skill stuck timeout threshold in milliseconds	0

Provider Configuration

Env	Description	Default Value
PROVIDER_DEFAULT_MODE	Default provider mode (global or custom)	custom

Default Models

Env	Description	Default Value
DEFAULT_MODEL_CHAT	Default chat model	(not set)
DEFAULT_MODEL_AGENT	Default agent model	(not set)
DEFAULT_MODEL_QUERY_ANALYSIS	Default query analysis model	(not set)
DEFAULT_MODEL_TITLE_GENERATION	Default title generation model	(not set)
DEFAULT_MODEL_IMAGE	Default image model	(not set)
DEFAULT_MODEL_VIDEO	Default video model	(not set)
DEFAULT_MODEL_AUDIO	Default audio model	(not set)

Stripe

Env	Description	Default Value
STRIPE_API_KEY	Stripe API key	(not set)
STRIPE_ACCOUNT_WEBHOOK_SECRET	Stripe account webhook secret	test
STRIPE_ACCOUNT_TEST_WEBHOOK_SECRET	Stripe test account webhook secret	test
STRIPE_SESSION_SUCCESS_URL	Stripe success redirect URL	(not set)
STRIPE_SESSION_CANCEL_URL	Stripe cancellation redirect URL	(not set)
STRIPE_PORTAL_RETURN_URL	Stripe customer portal return URL	(not set)

Quota

Token Quota

Env	Description	Default Value
QUOTA_T1_TOKEN	Tier 1 token quota	-1
QUOTA_T2_TOKEN	Tier 2 token quota	-1

Request Quota

Env	Description	Default Value
QUOTA_T1_REQUEST	Tier 1 request quota	-1
QUOTA_T2_REQUEST	Tier 2 request quota	-1

Storage Quota

Env	Description	Default Value
QUOTA_STORAGE_FILE	File storage quota	-1
QUOTA_STORAGE_OBJECT	Object storage quota	-1
QUOTA_STORAGE_VECTOR	Vector storage quota	-1

File Parse Quota

Env	Description	Default Value
QUOTA_FILE_PARSE_PAGE	File parse page quota	-1

Langfuse

Env	Description	Default Value
LANGFUSE_PUBLIC_KEY	Langfuse public key	(not set)
LANGFUSE_SECRET_KEY	Langfuse secret key	(not set)
LANGFUSE_HOST	Langfuse host URL	(not set)

Web Frontend

The following are the detailed configurations for the web frontend. You can inject these environment variables into the refly_web container.

General Config

Env	Description	Default Value
REFLY_API_URL	Refly API server URL	http://localhost:5800
COLLAB_URL	Collaboration endpoint URL	http://localhost:5801
SUBSCRIPTION_ENABLED	Whether to enable subscription and billing features	(not set)