# Environment

# System variables

Environment variables for the system context. Available server and docker.

Variable	Default
CHEVERETO_SERVICING	server
CHEVERETO_SERVICE_NAME	php
CHEVERETO_SERVICE_PORT	8080

# Context variables

Environment variables for the application context. Available self-hosted, saas. CHEVERETO_TRIAL controls if the system is in trial mode or not, in which case it uses CHEVERETO_TRIAL_ENABLE_* and CHEVERETO_TRIAL_MAX_* to control which features and limits are applied during trial.

Variable	Default
CHEVERETO_CONTEXT	self-hosted
CHEVERETO_TRIAL	0
CHEVERETO_TRIAL_ENABLE_*
CHEVERETO_TRIAL_MAX_*

# Database variables

Environment variables for the database details.

Variable	Default
CHEVERETO_DB_DRIVER	mysql
CHEVERETO_DB_HOST	localhost
CHEVERETO_DB_NAME
CHEVERETO_DB_PASS
CHEVERETO_DB_PDO_ATTRS	[]
CHEVERETO_DB_PORT	3306
CHEVERETO_DB_TABLE_PREFIX	chv_
CHEVERETO_DB_USER

# Error logging variables

Environment variables for handling error logging.

Variable	Default
CHEVERETO_ERROR_LOG_CLI
CHEVERETO_ERROR_LOG_CRON
CHEVERETO_ERROR_LOG	php://stderr

# Debug variables

Environment variables for debug.

Variable	Default
CHEVERETO_DEBUG_LEVEL	1

# Edition variable

Environment variable for the Chevereto edition.

Variable	Default
CHEVERETO_EDITION	pro

# xrDebug variables

Variable	Default
CHEVERETO_ENABLE_XRDEBUG	0
CHEVERETO_XRDEBUG_HOST	localhost
CHEVERETO_XRDEBUG_HTTPS	0
CHEVERETO_XRDEBUG_KEY
CHEVERETO_XRDEBUG_PORT	27420

# Hostname variables

Environment variables for the hostname configuration.

Variable	Default
CHEVERETO_HOSTNAME	localhost
CHEVERETO_HOSTNAME_PATH	/
CHEVERETO_HTTPS	1

For CHEVERETO_HOSTNAME it refers to the network identifier and it supports hostname, ip address and domain name. It also supports suffixing the port (e.g., example.com:8080).

"Network identifier" conveys the idea of any entity that can identify or locate a resource or device within a network.

# Encryption key

Environment variables for the encryption functionality.

Variable	Type
CHEVERETO_ENCRYPTION_KEY	base64 encoded (size 32)

# Session variables

Environment variables for the session driver.

Variable	Default
CHEVERETO_SESSION_SAVE_HANDLER	files
CHEVERETO_SESSION_SAVE_PATH	/tmp

# Image handling variables

Environment variables for controlling image handling.

Variable	Default
CHEVERETO_IMAGE_FORMATS_AVAILABLE	["AVIF","JPEG","PNG","BMP","GIF","WEBP"]
CHEVERETO_IMAGE_LIBRARY	imagick

# Binary paths

Environment variables for configuring binary tools used by Chevereto.

Variable	Default
CHEVERETO_BINARY_EXIFTOOL	exiftool
CHEVERETO_BINARY_EXIFTRAN	exiftran
CHEVERETO_BINARY_FFMPEG	ffmpeg
CHEVERETO_BINARY_FFPROBE	ffprobe

# Cache variables

Environment variables for setting up application-level caching.

Variable	Default
CHEVERETO_CACHE_DRIVER	redis
CHEVERETO_CACHE_HOST
CHEVERETO_CACHE_KEY_PREFIX	chv:
CHEVERETO_CACHE_PASSWORD
CHEVERETO_CACHE_PORT
CHEVERETO_CACHE_USER
CHEVERETO_CACHE_TIME_MICRO	60
CHEVERETO_CACHE_STAMPEDE_SLA	0

# Provider

Environment variables for configuring the service provider.

Variable	Default
CHEVERETO_PROVIDER_NAME	Self-hosted Chevereto
CHEVERETO_PROVIDER_URL

# Tenants

Environment variables for configuring multi-tenancy.

Variable	Default
CHEVERETO_TENANTS_API_REQUEST_SECRET
CHEVERETO_TENANTS_API_KEY_SECRET
CHEVERETO_TENANTS_API_IP_ALLOW_LIST
CHEVERETO_TENANT_ENFORCED	{}
CHEVERETO_TENANT

CHEVERETO_TENANTS_API_REQUEST_SECRET is used to sign requests to the Tenants API.
CHEVERETO_TENANTS_API_KEY_SECRET is used to verify requests coming from a known Tenants API key.
CHEVERETO_TENANTS_API_IP_ALLOW_LIST is used to restrict access to the Tenants API by IP address or network.
CHEVERETO_TENANT_ENFORCED is a JSON object that defines which variables will be enforced (overridden) for the multi-tenant context.
CHEVERETO_TENANT is intended to be used to pass the current tenant context for CLI.

# Toggles

Environment variables for the context where Chevereto system is being provided. Depending on where you run it, you may want to disable some Chevereto functionality.

Variable	Default
CHEVERETO_ENABLE_API_GUEST	1
CHEVERETO_ENABLE_API_USER	1
CHEVERETO_ENABLE_BANNERS	1
CHEVERETO_ENABLE_BULK_IMPORTER	1
CHEVERETO_ENABLE_CAPTCHA	1
CHEVERETO_ENABLE_CDN	1
CHEVERETO_ENABLE_CONSENT_SCREEN	1
CHEVERETO_ENABLE_COOKIE_COMPLIANCE	1
CHEVERETO_ENABLE_DEBUG	1
CHEVERETO_ENABLE_EXPOSE_PAID_FEATURES	1
CHEVERETO_ENABLE_EXTERNAL_SERVICES	1
CHEVERETO_ENABLE_EXTERNAL_STORAGE_PROVIDERS	1
CHEVERETO_ENABLE_FAVICON	1
CHEVERETO_ENABLE_FOLLOWERS	1
CHEVERETO_ENABLE_FORCE_POWERED_BY_FOOTER	0
CHEVERETO_ENABLE_HTACCESS_CHECK	0
CHEVERETO_ENABLE_IP_BANS	1
CHEVERETO_ENABLE_LANGUAGE_CHOOSER	1
CHEVERETO_ENABLE_LIKES	1
CHEVERETO_ENABLE_LOCAL_STORAGE	1
CHEVERETO_ENABLE_LOGIN_PROVIDERS	1
CHEVERETO_ENABLE_LOGO_CUSTOM	1
CHEVERETO_ENABLE_MODERATION	1
CHEVERETO_ENABLE_NEWS_CHECK	1
CHEVERETO_ENABLE_NOTIFICATIONS	1
CHEVERETO_ENABLE_PAGES	1
CHEVERETO_ENABLE_PHP_PAGES	0
CHEVERETO_ENABLE_POWERED_BY_SETTING	1
CHEVERETO_ENABLE_PUP_CUSTOM_URL	1
CHEVERETO_ENABLE_ROUTING	1
CHEVERETO_ENABLE_SEO_ALBUM_URL	1
CHEVERETO_ENABLE_SEO_IMAGE_URL	1
CHEVERETO_ENABLE_SERVICE_AKISMET	1
CHEVERETO_ENABLE_SERVICE_MODERATECONTENT	0
CHEVERETO_ENABLE_SERVICE_PROJECTARACHNID	1
CHEVERETO_ENABLE_SERVICE_STOPFORUMSPAM	1
CHEVERETO_ENABLE_STOPWORDS	1
CHEVERETO_ENABLE_TENANTS	0
CHEVERETO_ENABLE_UPDATE_CHECK	1
CHEVERETO_ENABLE_UPDATE_CLI	1
CHEVERETO_ENABLE_UPDATE_HTTP	1
CHEVERETO_ENABLE_UPLOAD_FLOOD_PROTECTION	1
CHEVERETO_ENABLE_UPLOAD_PLUGIN	1
CHEVERETO_ENABLE_UPLOAD_URL	1
CHEVERETO_ENABLE_UPLOAD_WATERMARK	1
CHEVERETO_ENABLE_USERS	1
CHEVERETO_ENABLE_XRDEBUG	0

# Limits

Environment variables that limits the use for Chevereto.

Zero 0 means no limit.

Variable	Default
CHEVERETO_MAX_ADMINS	0
CHEVERETO_MAX_ALBUMS	0
CHEVERETO_MAX_CACHE_TTL	86400
CHEVERETO_MAX_CATEGORIES	0
CHEVERETO_MAX_CHUNK_UPLOAD_SIZE	16M
CHEVERETO_MAX_EXECUTION_TIME	30
CHEVERETO_MAX_FILES	0
CHEVERETO_MAX_LISTING_ITEMS_PER_PAGE	0
CHEVERETO_MAX_LOGIN_PROVIDERS	0
CHEVERETO_MAX_MANAGERS	0
CHEVERETO_MAX_MEMORY_SIZE	512M
CHEVERETO_MAX_PAGES	0
CHEVERETO_MAX_POST_SIZE	64M
CHEVERETO_MAX_STORAGES	0
CHEVERETO_MAX_TAGS	0
CHEVERETO_MAX_TAGS_PER_FILE	0
CHEVERETO_MAX_TAGS_PER_LISTING	0
CHEVERETO_MAX_UPLOAD_FILE_SIZE	64M
CHEVERETO_MAX_UPLOAD_SIZE	100M
CHEVERETO_MAX_USER_ALBUMS_LIST	500
CHEVERETO_MAX_USERS	0
CHEVERETO_MIN_STORAGES_ACTIVE	0

For CHEVERETO_MAX_USER_ALBUMS_LIST it affects the number of albums on user's dropdown album menus.

# File upload

Environment variables for the file uploading limits. It applies only for our container provisioning.

For non-container based provisioning you need to change these settings at php.ini configuration.

Variable	Default
CHEVERETO_MAX_UPLOAD_FILE_SIZE	64M
CHEVERETO_MAX_POST_SIZE	64M
CHEVERETO_MAX_EXECUTION_TIME	30
CHEVERETO_MAX_MEMORY_SIZE	512M

# Proxy

Environment variables for tweaking server handling when the server is under a proxy.

Variable	Default
CHEVERETO_HEADER_CLIENT_IP
CHEVERETO_HEADER_FORWARDED_HOST	HTTP_X_FORWARDED_HOST
CHEVERETO_HEADER_ROUTER_SECRET	HTTP_X_ROUTER_SECRET
CHEVERETO_PROXY_ENTRYPOINT
CHEVERETO_PROXY_IP_ALLOW_LIST
CHEVERETO_ROUTER_SECRET

Note: CHEVERETO_HEADER_FORWARDED_HOST is followed only if passed CHEVERETO_HEADER_ROUTER_SECRET and CHEVERETO_ROUTER_SECRET match.

# Jobs

Environment variables for configuring the jobs worker.

Variable	Default
CHEVERETO_SCHEDULER_INTERVAL	300

CHEVERETO_SCHEDULER_INTERVAL is used to define how often (in seconds) the jobs scheduler will check for new jobs to process.

← Configuring Multitenancy →