.env.example

###########################
# Application configuration
###########################

# The public name of the application
LB_APP_TITLE='LibreBooking'

# Enable or disable debug mode for the application
# if enabled it will enable 'display_errors' and 'display_startup_errors' (true/false)
LB_APP_DEBUG=false

# Administrator email address
LB_ADMIN_EMAIL='admin@example.com'

# Display name used for outgoing admin emails
LB_ADMIN_EMAIL_NAME='LB Administrator'

# Company name to show in the page header
LB_COMPANY_NAME=

# URL to the company's website
LB_COMPANY_URL=

#######################
# Language and Timezone
#######################

# Default timezone.
# Options: Look up here https://php.net/manual/en/timezones.php
LB_DEFAULT_TIMEZONE='Europe/London'

# Default language.
# Options: Find your language in the lang directory
LB_DEFAULT_LANGUAGE='en_us'

# Restrict which languages appear in the language selector.
# Comma-separated list of language codes (e.g. 'en_us,fr_fr,de_de').
# Languages appear in the selector in the order listed.
# Leave empty to show all supported languages.
# Language codes must match those defined in lang/AvailableLanguages.php.
# If the value of `default.language` is not included in this list, the
# application will fall back to 'en_us' and log an error.
LB_ENABLED_LANGUAGES=

##########
# Frontend
##########

# Public URL to the Web directory of this instance
# This is the URL that appears when you are logging in
# Leave http: or https: off to auto-detect
LB_SCRIPT_URL=

# Password to access installation wizard under Web/install/
# Leave empty to disable the installation wizard
LB_INSTALL_PASSWORD=

# Enable template caching. Recommended for production. (true/false)
LB_CACHE_TEMPLATES=true

# Enable use of bundled/self-hosted frontend assets (JavaScript, CSS, fonts) (true/false)
LB_USE_LOCAL_JS_LIBS=true

# Session inactivity timeout in minutes
LB_INACTIVITY_TIMEOUT=30

# Home URL linked to application logo in header
LB_HOME_URL=

# URL to redirect users after logout
LB_LOGOUT_URL=

# Default homepage to use when new users register
# Options:  1 = Dashboard, 2 = Schedule, 3 = My Calendar, 4 = Resource Calendar
LB_DEFAULT_HOMEPAGE=1

# Default number of items per page in listings
# Use a positive integer. -1 is not supported for performance reasons
LB_DEFAULT_PAGE_SIZE=50

# Optional path to a custom CSS file
LB_CSS_EXTENSION_FILE=

# Name of the CSS theme to use
# Options: default, dimgray, dark_red, dark_green, french_blue, cake_blue, orange
LB_CSS_THEME='default'

# Display format when showing user names
LB_NAME_FORMAT='{first} {last}'

#######################
# Analytics Integration
#######################

# Google Analytics tracking ID (e.g., UA-XXXXXXX or G-XXXXXXXX)
LB_GOOGLE_ANALYTICS_TRACKING_ID=

###################
# Slack Integration
###################

# Slack webhook token for sending notifications
LB_SLACK_TOKEN=


#######
# Pages
#######

# Enable or disable the configuration page in the admin panel (true/false)
LB_PAGES_CONFIGURATION_ENABLED=true

##########
# Database
##########

# Database configuration. Only MySQL is supported
LB_DATABASE_TYPE='mysql'

# Database host address or IP.
LB_DATABASE_HOSTSPEC='127.0.0.1'

# Database name
LB_DATABASE_NAME='librebooking'

# Database username with access to the librebooking database
LB_DATABASE_USER='lb_user'

# Database password for the user
LB_DATABASE_PASSWORD='password'

###########################
# Email Sending (PHPMailer)
###########################

# Mailer type:
# Options: mail, smtp or sendmail
LB_PHPMAILER_MAILER='smtp'

# SMTP host address or IP
LB_PHPMAILER_SMTP_HOST=

# SMTP port
LB_PHPMAILER_SMTP_PORT=25

# SMTP encryption
# Options: tls, ssl
LB_PHPMAILER_SMTP_SECURE=

# SMTP Auto TLS, if an unencrypted SMTP connection should attempt to use STARTTLS (true/false)
LB_PHPMAILER_SMTP_AUTOTLS=true

# Enable SMTP authentication (true/false)
LB_PHPMAILER_SMTP_AUTH=true

# SMTP username
LB_PHPMAILER_SMTP_USERNAME=

# SMTP password
LB_PHPMAILER_SMTP_PASSWORD=

# Path to sendmail binary
LB_PHPMAILER_SENDMAIL_PATH='/usr/sbin/sendmail'

# Enable SMTP debug output (true/false)
LB_PHPMAILER_SMTP_DEBUG=false

#######
# Email
#######

# Enable or disable email notifications (true/false)
LB_EMAIL_ENABLED=true

# Enable custom email templates (true/false)
LB_EMAIL_ENFORCE_CUSTOM_TEMPLATE=false

# Default email address to use for outgoing emails
LB_EMAIL_DEFAULT_FROM_ADDRESS='no-reply@example.com'

# Default name to use for outgoing emails
LB_EMAIL_DEFAULT_FROM_NAME='LB'

#########
# Logging
#########

# Directory where logs are stored
# Write permission is required
LB_LOGGING_FOLDER='/var/log/librebooking/log'

# Logging level: none, debug, error
# Options: none, error, debug
LB_LOGGING_LEVEL='error'

# Enable SQL logging (true/false)
LB_LOGGING_SQL=false

#########
# Uploads
#########

# Full or relative path to where images will be stored
LB_UPLOADS_IMAGE_UPLOAD_DIRECTORY='Web/uploads/images'

# full or relative path to show uploaded images from
LB_UPLOADS_IMAGE_UPLOAD_URL='uploads/images'

# Enable reservation attachments (true/false)
LB_UPLOADS_RESERVATION_ATTACHMENTS_ENABLED=false

# Full or relative path to where reservation attachments will be stored
LB_UPLOADS_RESERVATION_ATTACHMENT_PATH='uploads/reservation'

# File extensions allowed for reservation attachments
LB_UPLOADS_RESERVATION_ATTACHMENT_EXTENSIONS='csv,doc,docx,gif,jpeg,jpg,pdf,png,ppt,pptx,txt,xls,xlsx'

########################################
# Notification Settings for Reservations
########################################

# Send notification to application administrators when a reservation is
# created (true/false)
LB_RESERVATION_NOTIFY_APPLICATION_ADMIN_ADD=false

# Send notification to application administrators when a reservation is
# updated (true/false)
LB_RESERVATION_NOTIFY_APPLICATION_ADMIN_UPDATE=false

# Send notification to application administrators when a reservation is
# deleted (true/false)
LB_RESERVATION_NOTIFY_APPLICATION_ADMIN_DELETE=false

# Send notification to application administrators when a reservation requires
# approval (true/false)
LB_RESERVATION_NOTIFY_APPLICATION_ADMIN_APPROVAL=false

# Send notification to group administrators when a reservation is created (true/false)
LB_RESERVATION_NOTIFY_GROUP_ADMIN_ADD=false

# Send notification to group administrators when a reservation is updated (true/false)
LB_RESERVATION_NOTIFY_GROUP_ADMIN_UPDATE=false

# Send notification to group administrators when a reservation is deleted (true/false)
LB_RESERVATION_NOTIFY_GROUP_ADMIN_DELETE=false

# Send notification to group administrators when a reservation requires
# approval (true/false)
LB_RESERVATION_NOTIFY_GROUP_ADMIN_APPROVAL=false

# Send notification to resource administrators when a reservation is created (true/false)
LB_RESERVATION_NOTIFY_RESOURCE_ADMIN_ADD=false

# Send notification to resource administrators when a reservation is updated (true/false)
LB_RESERVATION_NOTIFY_RESOURCE_ADMIN_UPDATE=false

# Send notification to resource administrators when a reservation is deleted (true/false)
LB_RESERVATION_NOTIFY_RESOURCE_ADMIN_DELETE=false

# Send notification to resource administrators when a reservation requires
# approval (true/false)
LB_RESERVATION_NOTIFY_RESOURCE_ADMIN_APPROVAL=false

###############################
# Schedule Display and Behavior
###############################

# Automatically scroll to today's date on load (true/false)
LB_SCHEDULE_AUTO_SCROLL_TODAY=true

# Show week numbers in the calendar view (true/false)
LB_SCHEDULE_SHOW_WEEK_NUMBERS=false

# Hide periods that are blocked or unavailable (true/false)
LB_SCHEDULE_HIDE_BLOCKED_PERIODS=false

# Display resources the user cannot access (true/false)
LB_SCHEDULE_SHOW_INACCESSIBLE_RESOURCES=true

# Format string for reservation labels (use placeholders like {name}, {title})
# Available properties are: {name}, {title}, {description}, {email}, {phone}, {organization}, {position}, {startdate}, {enddate} {resourcename} {participants} {invitees} {reservationAttributes}.
# Custom attributes can be added using att with the attribute id. For example {att1}
LB_SCHEDULE_RESERVATION_LABEL='{name}'

# Use different colors for each user's reservations (true/false)
LB_SCHEDULE_USE_PER_USER_COLORS=false

# Number of minutes to highlight updated reservations
LB_SCHEDULE_UPDATE_HIGHLIGHT_MINUTES=0

# Enable faster loading for reservation data (may reduce detail) (true/false)
LB_SCHEDULE_FAST_RESERVATION_LOAD=false

# Load simplified mobile views on small devices (true/false)
LB_SCHEDULE_LOAD_MOBILE_VIEWS=true

##############
# Reservations
##############

# Disable reservation participation/invitations and hide participant/invitee
# lists in the reservation UI (true/false)
LB_RESERVATION_PREVENT_PARTICIPATION=false

# Disable recurring reservations (true/false)
LB_RESERVATION_PREVENT_RECURRENCE=false

# Allow non-registered users (guests) to participate in reservations (true/false)
LB_RESERVATION_ALLOW_GUEST_PARTICIPATION=false

# Enable a waitlist for fully booked reservations (true/false)
LB_RESERVATION_ALLOW_WAIT_LIST=false

# Restrict start times (e.g., 'future', 'none', 'current')
# Note: In the standard reservation create/update flow, exemptions from this constraint apply only in specific cases:
#   - Application admins are always exempt.
#   - Group admins are exempt only when acting as admin for the reservation user.
#   - Resource and schedule admins are exempt only when they administer all resources in the reservation.
# Options: none, future, current
LB_RESERVATION_START_TIME_CONSTRAINT='future'

# Require approval when an existing reservation is updated (true/false)
LB_RESERVATION_UPDATES_REQUIRE_APPROVAL=false

# Require a title for all reservations (true/false)
LB_RESERVATION_TITLE_REQUIRED=false

# Require a description for all reservations (true/false)
LB_RESERVATION_DESCRIPTION_REQUIRED=false

# Number of minutes before start when check-in is allowed
LB_RESERVATION_CHECKIN_MINUTES_PRIOR=5

# Restrict check-in functionality to administrators only (true/false)
LB_RESERVATION_CHECKIN_ADMIN_ONLY=false

# Restrict check-out functionality to administrators only (true/false)
LB_RESERVATION_CHECKOUT_ADMIN_ONLY=false

# Enable reminder notifications for upcoming reservations (true/false)
LB_RESERVATION_REMINDERS_ENABLED=false

# Default reminder time before reservation start (e.g., '15 minutes', '1 hours', '1 days')
LB_RESERVATION_DEFAULT_START_REMINDER=

# Default reminder time before reservation end (e.g., '15 minutes', '1 hours', '1 days')
LB_RESERVATION_DEFAULT_END_REMINDER=

#############################
# Reservation Label Templates
#############################

# ICS calendar summary text for all reservations
# Available properties are: {name}, {title}, {description}, {email}, {phone}, {organization}, {position}, {startdate}, {enddate} {resourcename} {participants} {invitees} {reservationAttributes}.
# Custom attributes can be added using att with the attribute id. For example {att1}
LB_RESERVATION_LABELS_ICS_SUMMARY='{title}'

# ICS calendar summary text for a user's reservations
LB_RESERVATION_LABELS_ICS_MY_SUMMARY='{title}'

# RSS feed description template for reservations (HTML allowed)
LB_RESERVATION_LABELS_RSS_DESCRIPTION='<div><span>Start</span> {startdate}</div><div><span>End</span> {enddate}</div><div><span>Organizer</span> {name}</div><div><span>Description</span> {description}</div>'

# Label template used in the 'My Calendar' view
LB_RESERVATION_LABELS_MY_CALENDAR='{resourcename} {title}'

# Label template for resource-specific calendars
LB_RESERVATION_LABELS_RESOURCE_CALENDAR='{name}'

# Label used in display in reservation popups
LB_RESERVATION_LABELS_RESERVATION_POPUP=

############################
# Reporting and Registration
############################

# Allow all users to access reports (true/false)
LB_REPORTS_ALLOW_ALL_USERS=false

##############
# Registration
##############

# Enable self-registration for new users (true/false)
LB_REGISTRATION_ALLOW_SELF_REGISTRATION=true

# Require phone number during registration (true/false)
LB_REGISTRATION_REQUIRE_PHONE=false

# Require position/title during registration (true/false)
LB_REGISTRATION_REQUIRE_POSITION=false

# Require organization name during registration (true/false)
LB_REGISTRATION_REQUIRE_ORGANIZATION=false

# Hide phone field from the registration form (true/false)
LB_REGISTRATION_HIDE_PHONE=false

# Hide position/title field from the registration form (true/false)
LB_REGISTRATION_HIDE_POSITION=false

# Hide organization field from the registration form (true/false)
LB_REGISTRATION_HIDE_ORGANIZATION=false

# Enable CAPTCHA during user registration (true/false)
LB_REGISTRATION_CAPTCHA_ENABLED=true

# Require users to activate their account via email (true/false)
LB_REGISTRATION_REQUIRE_EMAIL_ACTIVATION=false

# Automatically subscribe new users to email notifications (true/false)
LB_REGISTRATION_AUTO_SUBSCRIBE_EMAIL=false

# Notify the admin when a new user registers (true/false)
LB_REGISTRATION_NOTIFY_ADMIN=false

##################
# Resource Options
##################

# Indicates if the contact must be a registered user (true/false)
LB_RESOURCE_CONTACT_IS_USER=false

#####################
# Tablet View Options
#####################

# Allow users to make reservations in the tablet view (true/false)
LB_TABLET_VIEW_ALLOW_RESERVATIONS=true

# Allow guests to make reservations from the tablet view (true/false)
LB_TABLET_VIEW_ALLOW_GUEST_RESERVATIONS=false

# Suggest known email addresses during reservation creation (true/false)
LB_TABLET_VIEW_AUTO_SUGGEST_EMAILS=false

##############
# ICS Settings
##############

# Enable or disable ICS calendar subscription feeds entirely (true/false)
LB_ICS_ENABLED=true

# Subscription key secret used for ICS calendar feeds
LB_ICS_SUBSCRIPTION_KEY=

# Number of future days to include in ICS feeds
LB_ICS_FUTURE_DAYS=30

# Number of past days to include in ICS feeds
LB_ICS_PAST_DAYS=0

#############################
# Data Retention and Deletion
#############################

# Requires  'deleteolddata.php' to run as a cron job
# Number of years after which old data is considered for deletion
LB_CLEANUP_YEARS_OLD_DATA=3

# Automatically delete old announcements (true/false)
LB_CLEANUP_DELETE_OLD_ANNOUNCEMENTS=false

# Automatically delete old blackout periods (true/false)
LB_CLEANUP_DELETE_OLD_BLACKOUTS=false

# Automatically delete old reservations (true/false)
LB_CLEANUP_DELETE_OLD_RESERVATIONS=false

#################
# Password Policy
#################

# Disable the 'Forgot Password' feature (true/false)
LB_PASSWORD_DISABLE_RESET=false

# Minimum number of characters required in passwords
LB_PASSWORD_MINIMUM_LENGTH=8

# Minimum number of numeric digits required in passwords
LB_PASSWORD_MINIMUM_NUMBERS=1

# Require both upper and lower case characters in passwords (true/false)
LB_PASSWORD_UPPER_AND_LOWER=true

# Minimum number of special characters required in passwords
LB_PASSWORD_MINIMUM_SPECIALCHAR=1

#########
# Privacy
#########

# Allow public (not logged-in) users to view schedule and calendar pages (true/false)
LB_PRIVACY_VIEW_SCHEDULES=true

# When true, public (unauthenticated) views show reservation details.
# When false (default), public views show only that a slot is occupied with no content. (true/false)
LB_PRIVACY_VIEW_RESERVATIONS=false

# When true, non-owner/non-admin users see "Private" instead of the organizer name and email (true/false)
LB_PRIVACY_HIDE_USER_DETAILS=false

# Hide reservation details from general users (true/false)
LB_PRIVACY_HIDE_RESERVATION_DETAILS=false

# Allow guest users to make reservations (true/false)
LB_PRIVACY_ALLOW_GUEST_RESERVATIONS=false

# Set number of days in the future for which reservations can be made by guest users
LB_PRIVACY_PUBLIC_FUTURE_DAYS=30

###########
# reCAPTCHA
###########

# Enable Google reCAPTCHA on login or registration (true/false)
LB_RECAPTCHA_ENABLED=false

# Google reCAPTCHA public site key
LB_RECAPTCHA_PUBLIC_KEY=

# Google reCAPTCHA secret key
LB_RECAPTCHA_PRIVATE_KEY=

# HTTP request method used for verification
# Options: curl, post, socket
LB_RECAPTCHA_REQUEST_METHOD='curl'

##################
# Security Headers
##################

# Enable the following security headers in HTTP responses (true/false)
LB_SECURITY_HEADERS=false

# HTTP Strict Transport Security (HSTS) header value
LB_SECURITY_STRICT_TRANSPORT='max-age=31536000'

# X-Frame-Options header value (e.g., deny, sameorigin)
LB_SECURITY_X_FRAME='deny'

# X-Content-Type-Options header value
LB_SECURITY_X_CONTENT_TYPE='nosniff'

# Set the Content-Security-Policy header value
LB_SECURITY_CONTENT_SECURITY_POLICY=

########################
# Credit System Settings
########################

# Enable credit-based reservation system (true/false)
LB_CREDITS_ENABLED=false

# Allow users to purchase credits (true/false)
LB_CREDITS_ALLOW_PURCHASE=false

#########################
# Authentication Settings
#########################

# Hide the login prompt (true/false)
LB_AUTHENTICATION_HIDE_LOGIN_PROMPT=false

# Enable CAPTCHA on login page (true/false)
LB_AUTHENTICATION_CAPTCHA_ON_LOGIN=false

# Restrict registration to specific email domains (comma-separated, e.g., example.com,school.edu)
LB_AUTHENTICATION_REQUIRED_EMAIL_DOMAINS=

# Enable login via Google (true/false)
LB_AUTHENTICATION_GOOGLE_LOGIN_ENABLED=false

# Google OAuth2 client credentials
LB_AUTHENTICATION_GOOGLE_CLIENT_ID=

# Client secret for Google OAuth login
LB_AUTHENTICATION_GOOGLE_CLIENT_SECRET=

# Path to the Google redirect URI
# /Web/google-auth.php
LB_AUTHENTICATION_GOOGLE_REDIRECT_URI='/Web/google-auth.php'

# Enable login via Microsoft (true/false)
LB_AUTHENTICATION_MICROSOFT_LOGIN_ENABLED=false

# Microsoft OAuth2 client credentials
LB_AUTHENTICATION_MICROSOFT_CLIENT_ID=

# Replace with your tenant id if the app is single tenant
LB_AUTHENTICATION_MICROSOFT_TENANT_ID='common'

# Microsoft OAuth2 client secret
LB_AUTHENTICATION_MICROSOFT_CLIENT_SECRET=

# Path to the Microsoft redirect URI
# /Web/microsoft-auth.php
LB_AUTHENTICATION_MICROSOFT_REDIRECT_URI='/Web/microsoft-auth.php'

# Enable login via Facebook (true/false)
LB_AUTHENTICATION_FACEBOOK_LOGIN_ENABLED=false

# Facebook App credentials
LB_AUTHENTICATION_FACEBOOK_CLIENT_ID=

# Facebook App client secret
LB_AUTHENTICATION_FACEBOOK_CLIENT_SECRET=

# Facebook OAuth2 redirect URI
# /Web/facebook-auth.php
LB_AUTHENTICATION_FACEBOOK_REDIRECT_URI='/Web/facebook-auth.php'

# Enable login via Keycloak (true/false)
LB_AUTHENTICATION_KEYCLOAK_LOGIN_ENABLED=false

# Keycloak OAuth2 credentials
LB_AUTHENTICATION_KEYCLOAK_URL=

# Realm for Keycloak authentication
LB_AUTHENTICATION_KEYCLOAK_REALM=

# Client ID for Keycloak OAuth login
LB_AUTHENTICATION_KEYCLOAK_CLIENT_ID=

# Client secret for Keycloak OAuth login
LB_AUTHENTICATION_KEYCLOAK_CLIENT_SECRET=

# Redirect URI for Keycloak OAuth login
LB_AUTHENTICATION_KEYCLOAK_CLIENT_URI='/Web/keycloak-auth.php'

# Enable login via custom OAuth2 provider (true/false)
LB_AUTHENTICATION_OAUTH2_LOGIN_ENABLED=false

# OAuth2 identity provider name (shown on login button)
LB_AUTHENTICATION_OAUTH2_NAME='OAuth2'

# OAuth2 endpoint URLs and client credentials
# If true, the configured authorize URL's trailing slash is removed (true/false)
LB_AUTHENTICATION_OAUTH2_STRIP_TRAILING_SLASH=true

# Authorization URL for OAuth2 login
LB_AUTHENTICATION_OAUTH2_URL_AUTHORIZE=

# Token URL for OAuth2 login
LB_AUTHENTICATION_OAUTH2_URL_TOKEN=

# Userinfo URL for OAuth2 login
LB_AUTHENTICATION_OAUTH2_URL_USERINFO=

# Client ID for OAuth2 login
LB_AUTHENTICATION_OAUTH2_CLIENT_ID=

# Client secret for OAuth2 login
LB_AUTHENTICATION_OAUTH2_CLIENT_SECRET=

# Redirect URI for OAuth2 login
LB_AUTHENTICATION_OAUTH2_CLIENT_URI='/Web/oauth2-auth.php'

######################
# Plugin Configuration
######################

# Plugin class name to use for authentication
# Options: ActiveDirectory, Apache, CAS, Drupal, Krb5, Ldap, Mellon, Moodle, MoodleAdv, Saml, Shibboleth, WordPress
LB_PLUGINS_AUTHENTICATION=

# Plugin class name to use for authorization
LB_PLUGINS_AUTHORIZATION=

# Plugin class name to handle data export
LB_PLUGINS_EXPORT=

# Plugin class name for permission management
LB_PLUGINS_PERMISSION=

# Plugin class name to run after user registration
LB_PLUGINS_POSTREGISTRATION=

# Plugin class name to run before reservation creation
# Options: AdminCheckOnly, PreReservationExample
LB_PLUGINS_PRERESERVATION=

# Plugin class name to run after reservation is created/updated
# Options: PostReservationExample
LB_PLUGINS_POSTRESERVATION=

# Plugin class name to apply custom styling logic
LB_PLUGINS_STYLING=

###################
# API Configuration
###################

# Enable or disable the API (true/false)
LB_API_ENABLED=false

# Allow users to self-register via the API (true/false)
LB_API_REGISTRATION_ALLOW_SELF=false

# If set, a user must belong to this group to authenticate via the API
# Admin users are exempt
LB_API_AUTHENTICATION_GROUP=

# Restrict read-only access to Accessories via API to this group
# NOTE: There are no write APIs for Accessories
LB_API_ACCESSORIES_RO_GROUP=

# Restrict read-only access to Accounts via API to this group
LB_API_ACCOUNTS_RO_GROUP=

# Restrict read-write access to Accounts via API to this group
LB_API_ACCOUNTS_RW_GROUP=

# Restrict read-only access to Attributes via API to this group
# NOTE: Only application administrators can modify Attributes
LB_API_ATTRIBUTES_RO_GROUP=

# Restrict read-only access to Groups via API to this group
# NOTE: Only application administrators can modify Groups
LB_API_GROUPS_RO_GROUP=

# Restrict read-only access to Reservations via API to this group
LB_API_RESERVATIONS_RO_GROUP=

# Restrict read-write access to Reservations via API to this group
LB_API_RESERVATIONS_RW_GROUP=

# Restrict read-only access to Resources via API to this group
# NOTE: Only application administrators can modify Resources
LB_API_RESOURCES_RO_GROUP=

# Restrict read-only access to Schedules via API to this group
# NOTE: There are no write APIs for Schedules
LB_API_SCHEDULES_RO_GROUP=

# Restrict read-only access to Users via API to this group
# NOTE: Only application administrators can modify Users
LB_API_USERS_RO_GROUP=