Configuration Settings

Configuration Settings can be managed in Application Configuration. These settings can also be edited directly in the config.php file.

$conf['settings']['app.title']

The title of the application to be used in the browser. Default is false.

$conf['settings']['default.timezone']

The default timezone to use. If not set, the server timezone will be used. Possible values are located here: http://php.net/manual/en/timezones.php

$conf['settings']['allow.self.registration']

If users are allowed to register new accounts. Default is false.

$conf['settings']['admin.email']

The email address of the main application administrator

$conf['settings']['enable.email']

Whether or not any emails are sent out of Booked Scheduler

$conf['settings']['default.language']

Default language for all users. This can be any language in the Booked Scheduler lang directory

$conf['settings']['script.url']

The full public URL to the root of this instance of Booked Scheduler. This should be the Web directory which contains files like schedule.php and calendar.php. If this value starts with //, then the protocol (http vs https) will be automatically detected.

$conf['settings']['image.upload.directory']

The physical directory to store images. This directory will need to be writable (755 suggested). This can be the full directory or relative to the Booked Scheduler root directory.

$conf['settings']['image.upload.url']

The URL where uploaded images can be viewed from. This can be the full URL or relative to $conf[‘settings’][‘script.url’].

$conf['settings']['cache.templates']

Whether or not templates are cached. It is recommended to set this to true, as long as tpl_c is writable

$conf['settings']['use.local.js.libs']

Whether or not a local version of javascript libraries files should be used. If set to false, the files will be served from a CDN. It is recommended to set this to false to improve performance and bandwidth usage. Default is false.

$conf['settings']['registration.captcha.enabled']

Whether or not captcha image security is enabled during user account registration

$conf['settings']['registration.require.email.activation']

Whether or not a user will be required to activate their account by email before logging in.

$conf['settings']['registration.auto.subscribe.email']

Whether or not users will be automatically subscribed to all emails upon registration.

$conf['settings']['registration.notify.admin']

Whether or not admins will be notified upon new user registration.

$conf['settings']['inactivity.timeout']

Number of minutes before an inactive user is logged out. Leave this blank to use the server default. If set, you must also configure the session.save.path.

$conf['settings']['session.save.path']

The full path to the directory to be used to store PHP session data. The user or group running PHP (typically apache) must have full read/write access to this directory.

$conf['settings']['name.format']

Display format for first name and last name. Default is ‘{first} {last}’ .

$conf['settings']['disable.password.reset']

If the password reset functionality should be disabled. Default is false.

$conf['settings']['home.url']

Where the user will be redirected when the logo is clicked. Default is the user’s homepage.

$conf['settings']['logout.url']

Where the user will be redirected after being logged out. Default is the login page.

$conf['settings']['help.url']

Where the user will be redirected when clicking help. Default is the Booked help documentation.

$conf['settings']['default.homepage']

The default homepage to use when new users register 1 = Dashboard, 2 = Schedule, 3 = My Calendar, 4 = Resource Calendar. Default is 1 (Dashboard)

$conf['settings']['first.day.of.week']

The first day of the week to use for calendars. Default is 0 (Sunday)

$conf['settings']['schedule']['use.per.user.colors']

Use user-specific, administrator-defined colors for reservations. Default is false.
$conf['settings']['schedule']['show.inaccessible.resources']

Whether or not resources that are not accessible to the user are displayed in the schedule

$conf['settings']['schedule']['reservation.label']

The format of what to display for the reservation slot on the Bookings page. Available tokens are listed in the Available Label Tokens section.

$conf['settings']['schedule']['hide.blocked.periods']

If blocked periods should be hidden on the bookings page. Default is false.

$conf['settings']['schedule']['update.highlight.minutes']

If set, a new or updated indicator will show on the reservation label for the duration after a reservation is created or updated. Default is none.

$conf['settings']['schedule']['show.week.numbers']

Whether or not week numbers are shown on the schedule. Default is false.

$conf['settings']['schedule']['show.checkin.information']

Whether or not check in/out icons are shown on the schedule. Default is false.

$conf['settings']['ics']['subscription.key']

If you want to allow calendar subscriptions, set this to a difficult to guess value. If nothing is set then calendar subscriptions will be disabled.

$conf['settings']['ics']['future.days']

The number of days into the future to show on ics feeds. Default is 30.

$conf['settings']['ics']['past.days']

The number of days into the past to show on ics feeds. Default is 0.

$conf['settings']['privacy']['view.schedules']

If non-authenticated users can view the booking schedules. Default is false.

$conf['settings']['privacy']['view.reservations']

If non-authenticated users can view reservation details. Default is false.

$conf['settings']['privacy']['hide.user.details']

If non-administrators can view personal information about other users. Default is false.

$conf['settings']['privacy']['hide.reservation.details']

If non-administrators can view reservation details. Options are true, false, past, current, future. Default is false.

$conf['settings']['privacy']['allow.guest.reservations']

Whether or not to allow non-registered users to reserve. Default is false.

$conf['settings']['reservation']['start.time.constraint']

When reservations can be created or edited. Options are future, current, none. Future means reservations cannot be created or modified if the starting time of the selected slot is in the past. Current means reservations can be created or modified if the ending time of the selected slot is not in the past. None means that there is no restriction on when reservations can be created or modified. Default is future.

$conf['settings']['reservation']['updates.require.approval']

Whether or not updates to reservations which have previously been approved require approval again. Default is false.

$conf['settings']['reservation']['prevent.participation']

Whether or not users should be prevented from adding and inviting others to a reservation. Default is false.

$conf['settings']['reservation']['prevent.recurrence']

Whether or not users should be prevented creating recurring reservations. Default is false.

$conf['settings']['reservation']['enable.reminders']

Whether or not users can be reminded about their reservations via email. This requires the reminders job to be running. Default is false.

$conf['settings']['reservation']['allow.guest.participation']

Whether or not non-registered users can be invited to reservations. Default is false.

$conf['settings']['reservation']['allow.wait.list']

Whether or not users can be notified of time slot availability. This requires the wait list job to be running. Default is false.

$conf['settings']['reservation']['checkin.minutes.prior']

The amount of time before a reservation starts that someone can check into it. Default is 5 minutes.

$conf['settings']['reservation']['default.start.reminder']

The default start reminder for reservations. The format is # interval. For example, 10 minutes, 1 hours, 4 days. Default is empty.

$conf['settings']['reservation']['default.end.reminder']

The default end reminder for reservations. The format is # interval. For example, 10 minutes, 1 hours, 4 days. Default is empty.

$conf['settings']['reservation']['title.required']

Whether or not the title of a reservation is required when creating or updating reservations. Default is false.

$conf['settings']['reservation']['description.required']

Whether or not the description of a reservation is required when creating or updating reservations. Default is false.

$conf['settings']['reservation']['cancel.reason.required']

Whether or not the a reason must be provided when cancelling a reservation. Default is false.

$conf['settings']['reservation']['user.total.concurrent.limit']

The maximum number of concurrent reservations each user can have. Setting this to 0 allows unlimited concurrent reservations for a user.

$conf['settings']['reservation']['show.detailed.save.information']

Whether or not to show resources, time, and dates on the reservation save confirmation message. Default is false.

$conf['settings']['reservation']['maximum.resource.checklist']

The maximum number of resources to show as a checklist when making a reservation. More resources will change to a filterable dropdown. Default is 30.

$conf['settings']['reservation']['limit.invitees.to.max.participants']

If true, the maximum number of invitees will be limited to the resource capacity. Default is false.

$conf['settings']['reservation']['allow.meeting.links']

If meeting links (Zoom, manually created meetings) are available on the reservation. Default is false.

$conf['settings']['reservation']['default.allow.others.to.join']

If the ‘Allow Others to Join’ reservation option is enabled by default. Default is false.

$conf['settings']['reservation']['allow.reservation.color']

If the reservation owner can set the display color for their reservations. Default is false.

$conf['settings']['reservation.notify']['application.admin.add']

Whether or not to send an email to all application administrators when a reservation is created. Default is false.

$conf['settings']['reservation.notify']['application.admin.update']

Whether or not to send an email to all application administrators when a reservation is updated. Default is false.

$conf['settings']['reservation.notify']['application.admin.delete']

Whether or not to send an email to all application administrators when a reservation is deleted. Default is false.

$conf['settings']['reservation.notify']['application.admin.approval']

Whether or not to send an email to all application administrators when a reservation requires approval. Default is false.

$conf['settings']['reservation.notify']['application.admin.missed.checkin']

Whether or not to send an email to all application administrators when a reservation missed the check in time. Default is false.

$conf['settings']['reservation.notify']['application.admin.missed.checkout']

Whether or not to send an email to all application administrators when a reservation missed the check out time. Default is false.

$conf['settings']['reservation.notify']['resource.admin.add']

Whether or not to send an email to all resource and schedule administrators when a reservation is created. Default is false.

$conf['settings']['reservation.notify']['resource.admin.update']

Whether or not to send an email to all resource and schedule administrators when a reservation is updated. Default is false.

$conf['settings']['reservation.notify']['resource.admin.delete']

Whether or not to send an email to all resource and schedule administrators when a reservation is deleted. Default is false.

$conf['settings']['reservation.notify']['resource.admin.approval']

Whether or not to send an email to all resource and schedule administrators when a reservation requires approval. Default is false.

$conf['settings']['reservation.notify']['resource.admin.missed.checkin']

Whether or not to send an email to all resource and schedule administrators when a reservation missed the check in time. Default is false.

$conf['settings']['reservation.notify']['resource.admin.missed.checkout']

Whether or not to send an email to all resource and schedule administrators when a reservation missed the check out time. Default is false.

$conf['settings']['reservation.notify']['group.admin.add']

Whether or not to send an email to all group administrators when a reservation is created. Default is false.

$conf['settings']['reservation.notify']['group.admin.update']

Whether or not to send an email to all group administrators when a reservation is updated. Default is false.

$conf['settings']['reservation.notify']['group.admin.delete']

Whether or not to send an email to all group administrators when a reservation is deleted. Default is false.

$conf['settings']['reservation.notify']['group.admin.approval']

Whether or not to send an email to all group administrators when a reservation requires approval. Default is false.

$conf['settings']['reservation.notify']['group.admin.missed.checkin']

Whether or not to send an email to all group administrators when a reservation missed the check in time. Default is false.

$conf['settings']['reservation.notify']['group.admin.missed.checkout']

Whether or not to send an email to all group administrators when a reservation missed the check out time. Default is false.

$conf['settings']['uploads']['enable.reservation.attachments']

If users are allowed to attach files to reservations. Default is false.

$conf['settings']['uploads']['reservation.attachment.path']

The full or relative filesystem path (relative to the root of your Booked Scheduler directory) to store reservation attachments. This directory must be writable by PHP (755 suggested). Default is uploads/reservation

$conf['settings']['uploads']['reservation.attachment.extensions']

Comma separated list of safe file extensions. Leaving this blank will allow all file types (not recommended).

$conf['settings']['database']['user']

Database user with access to the configured database

$conf['settings']['database']['password']

Password for the database user

$conf['settings']['database']['hostspec']

Database host URL or named pipe

$conf['settings']['database']['name']

Name of Booked Scheduler database

$conf['settings']['phpmailer']['mailer']

PHP email library. Options are mail, smtp, sendmail, qmail. Default is mail (inherit PHP mail settings)

$conf['settings']['phpmailer']['smtp.host']

SMTP host, if using smtp

$conf['settings']['phpmailer']['smtp.port']

SMTP port, if using smtp, usually 25

$conf['settings']['phpmailer']['smtp.secure']

SMTP security, if using smtp. Options are ”, ssl or tls

$conf['settings']['phpmailer']['smtp.auth']

SMTP requies authentication, if using smtp. Options are true or false

$conf['settings']['phpmailer']['smtp.username']

SMTP username, if using smtp

$conf['settings']['phpmailer']['smtp.password']

SMTP password, if using smtp

$conf['settings']['phpmailer']['sendmail.path']

Path to sendmail, if using sendmail

$conf['settings']['plugins']['Authentication']

Name of authentication plugin to use. For more on plugins, see Plugins below

$conf['settings']['plugins']['Authorization']

Name of authorization plugin to use. For more on plugins, see Plugins below

$conf['settings']['plugins']['Permission']

Name of permission plugin to use. For more on plugins, see Plugins below

$conf['settings']['plugins']['PreReservation']

Name of prereservation plugin to use. For more on plugins, see Plugins below

$conf['settings']['plugins']['PostReservation']

Name of postreservation plugin to use. For more on plugins, see Plugins below

$conf['settings']['install.password']

If you are running an installation or upgrade, you will be required to provide a value here. Set this to any random value.

$conf['settings']['pages']['enable.configuration']

If the configuration management page should be available to application administrators. Default is true.

$conf['settings']['api']['enabled']

If the Booked Scheduler’s RESTful API should be enabled. Default is false.

$conf['settings']['api']['allow.self.registration']

Whether or new user registration is available through the API. Default is false.

$conf['settings']['recaptcha']['enabled']

If reCAPTCHA should be used instead of the built in captcha. Default is false.

$conf['settings']['recaptcha']['public.key']

Your reCAPTCHA public key. Visit www.google.com/recaptcha to sign up.

$conf['settings']['recaptcha']['private.key']

Your reCAPTCHA private key. Visit www.google.com/recaptcha to sign up.

$conf['settings']['recaptcha']['recaptcha.version']

reCAPTCHA version to use. Options are 2 or 3. Default is 2.

$config['settings']['email']['default.from.address']

The email address to use as the ‘from’ address when sending emails. If emails are bouncing or being marked as spam, set this to an email address with your domain name. For example, noreply@yourdomain.com. This will not change the ‘from’ name or the reply-to address.

$config['settings']['email']['default.from.name']

The friendly name to use as the ‘from’ address when sending emails.

$conf['settings']['reports']['allow.all.users']

If non-administrators can access usage reports. Default is false.

$conf['settings']['reports']['restrict.to.application.admins']

If false, all levels of administrators are able to able to access reports. Default is false.

$conf['settings']['password']['minimum.letters']

Minimum number of letters required for user passwords. Default is 6.

$conf['settings']['password']['minimum.numbers']

Minimum number of numbers required for user passwords. Default is 0.

$conf['settings']['password']['upper.and.lower']

Whether user passwords require a combination of upper and lower case letters. Default is false.

$conf['settings']['reservation.labels']['ics.summary']

The format of what to display in the summary field for ics feeds. Available tokens are listed in the Available Label Tokens section. Default is title.

$conf['settings']['reservation.labels']['ics.my.summary']

The format of what to display in the summary field for your personal ics feeds. Available tokens are listed in the Available Label Tokens section. Default is title.

$conf['settings']['reservation.labels']['ics.description']

The format of what to display in the description field for ics feeds. Available tokens are listed in the Available Label Tokens section. Default is description.

$conf['settings']['reservation.labels']['ics.my.description']

The format of what to display in the description field for your personal ics feeds. Available tokens are listed in the Available Label Tokens section. Default is description.

$conf['settings']['reservation.labels']['rss.description']

The format of what to display in the description field for rss/atom feeds. Available tokens are listed in the Available Label Tokens section. Default is description.

$conf['settings']['reservation.labels']['my.calendar']

The format of what to display for the reservation label on the My Calendar page. Available tokens are listed in the Available Label Tokens section.

$conf['settings']['reservation.labels']['resource.calendar']

The format of what to display for the reservation label on the Resource Calendar page. Available tokens are listed in the Available Label Tokens section.

$conf['settings']['reservation.labels']['reservation.popup']

The format of what to display in reservation popups. Possible values are {name} {dates} {duration} { title} {resources} {participants} {accessories} {description} {phone} {email} {attributes} {pending}. Reservation custom attributes can be individually added using att with the attribute id. For example {att1}. Default is all information.

$conf['settings']['google.analytics']['tracking.id']

Your Google Analytics Tracking ID. If this is set then Google Analytics tracking code will be added to every page in Booked Scheduler.

$conf['settings']['security']['security.headers']

Enables advanced security headers, such as Content Security Policy, X-Frame-Options and more. Default is false.

$conf['settings']['authentication']['allow.google.login']

If users can log in to Booked Scheduler using Google. Default is false.

$conf['settings']['authentication']['hide.booked.login.prompt']

If the username and password fields should be hidden. Default is false.

$conf['settings']['authentication']['captcha.on.login']

If true, a captcha will be required to complete at login. Default is false.

$conf['settings']['authentication']['allow.oauth.login']

If true, administrators will be able to add 3rd party OAuth providers for SSO. Default is false.

$conf['settings']['credits']['enabled']

Whether or not credit functionality is enabled. Default is false.

$conf['settings']['credits']['allow.purchase']

Whether or not users can purchase credits. Credits must be enabled for this functionality to work. Default is false.

$conf['settings']['slack']['token']

Slack verification token. If this is not set, Slack slash commands will not work.

$conf['tablet.view']['allow.guest.reservations']

Whether or not to allow guest reservations from the tablet view. Default is false.

$conf['tablet.view']['auto.suggest.emails']

Whether or not to automatically suggest emails on tablet view. Default is false.

$conf['registration']['require.phone']

Whether or not to require phone numbers on registration. Default is false.

$conf['registration']['require.position']

Whether or not to require position on registration. Default is false.

$conf['registration']['require.organization']

Whether or not to require organization on registration. Default is false.

$conf['registration']['lock.timezone']

If true, the user will not be able to update their timezone. Default is false.

$conf['registration']['profile.updates.disabled']

If true, the user will not be able to update their own profile. Default is false.

$conf['registration']['bypass.first.login.screen']

If true, the first login “getting started” screen will not be shown. Default is false.

$conf['jobs']['php.exec.path']

The path to php executable on the web server. Default is php.

$conf['mfa']['mfa.required']

If users must use multi-factor authentication. Default is false.

$conf['resource.maps']['enable.maps']

If true, Resource Maps can be used to view and book resources. Default is none.

$conf['payments']['allow.reservation.payments']

Allow integrated payments for reservations. Default is false.

$conf['payments']['cancel.unpaid.reservations']

If true, unpaid reservations will be cancelled at their scheduled start time. Default is false.

Available Reservation Label Tokens #

Custom attributes can be added using att with the attribute id. For example {att1}

Leave it blank for no label. Any combination of tokens can be used.