Files
PhialsBasementandClaude Opus 5.5 d451885216 Add optional Zoho OAuth login
Setting ZOHO_OAUTH_ENABLED with a client ID and secret adds a "Login
with Zoho" button to the login page. Zoho users are matched by a new
users.zoho_id column. An existing account with the same email is linked
to Zoho. Otherwise a new verified account is created, unless
ZOHO_ALLOW_SIGNUP is off, which is the default when registration is
disabled.

Also configurable: redirect URI, data-center accounts server, scopes,
allowed email domains and the tier for new accounts. All are documented
in .env.example and passed through in docker-compose.yml.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-25 12:20:46 +10:00

72 lines
2.9 KiB
Bash

# LibreCrawl Docker Environment Configuration
# Host binding for the application
# - 127.0.0.1 = localhost only (local development)
# - 0.0.0.0 = all interfaces (production, accessible from network)
HOST_BINDING=127.0.0.1
# The port binding for the application
EXTERNAL_PORT=5000
# Secret key used to sign session cookies. MUST be a unique random value in
# production — generate one with:
# python -c "import secrets; print(secrets.token_hex(32))"
# If left unset, an ephemeral random key is generated at startup (secure, but
# sessions will not survive a restart).
# SECRET_KEY=
# Local mode - enables auto-login with admin access, no rate limits
# WARNING: "true" disables ALL authentication and grants every visitor admin
# access. Only enable for local development. Keep "false" for any networked or
# production deployment.
LOCAL_MODE=false
# Disable user registrations
# Set to "true" to prevent new users from registering
# Useful for production environments where you only want existing users
REGISTRATION_DISABLED=false
# DANGEROUSLY SKIP AUTH
# Set to "true" to let anyone log in as any username with no password.
# The username is only used to keep per-user sessions separate.
# DO NOT enable on a public network or in production.
DANGEROUSLY_SKIP_AUTH=false
# Zoho OAuth login
# Adds a "Login with Zoho" button to the login page. Create a "Server-based
# Application" client at https://api-console.zoho.com and register the
# redirect URI below as its Authorized Redirect URI.
ZOHO_OAUTH_ENABLED=false
# ZOHO_CLIENT_ID=
# ZOHO_CLIENT_SECRET=
# Must match the Authorized Redirect URI exactly. Set it explicitly when
# running behind a reverse proxy (e.g. Caddy/nginx terminating HTTPS).
# Default: <current host>/auth/zoho/callback
# ZOHO_REDIRECT_URI=https://crawl.example.com/auth/zoho/callback
# Accounts server for the data center your client was created in:
# .com (default), .eu, .in, .com.au, .jp, .sa, or https://accounts.zohocloud.ca
# ZOHO_ACCOUNTS_URL=https://accounts.zoho.com
# Requested scopes (default: openid,email,profile)
# ZOHO_SCOPES=openid,email,profile
# Only allow these email domains (comma-separated). Empty = any Zoho account.
# ZOHO_ALLOWED_DOMAINS=example.com,example.org
# Create a LibreCrawl account the first time a Zoho user logs in. Defaults to
# "true", or "false" when REGISTRATION_DISABLED=true. Existing accounts with a
# matching email are always linked.
# ZOHO_ALLOW_SIGNUP=true
# Tier given to accounts created via Zoho: guest, user, extra, admin
# ZOHO_DEFAULT_TIER=user
# Email Configuration for verification emails
# SMTP server settings
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your-email@gmail.com
SMTP_PASSWORD=your-app-password
SMTP_FROM=noreply@librecrawl.com
SMTP_FROM_NAME=LibreCrawl
# Base URLs for email links (used to generate verification links)
MAIN_APP_URL=https://crawl.librecrawl.com
WORKSHOP_APP_URL=https://workshop.librecrawl.com