db_name.php configuration file - olszowka/Zambia GitHub Wiki

db_name.php configuration file

Make a copy of the file webpages/db_name_sample.php, put it in the parent directory of webpages, name it db_name.php and edit it as follows.

  • DBHOSTNAME

    Set to machine name with mysql server. Could be "localhost".

  • DBUSERID

    Set to mysql user id of user with CRUD access to DB. For best security, this user should not have permissions to edit schema.

  • DBPASSWORD

    Password for user above.

  • DBDB

    Name of database for Zambia.

  • CON_NAME

    Name of convention, which will appear on various pages in Zambia.

  • BRAINSTORM_EMAIL

    Appears on some "mailto: links on some brainstorm pages.

  • PROGRAM_EMAIL

    Appears in many "mailto: links throughout Zambia.

  • CON_NUM_DAYS

    Set to a number between 1-8 representing the length of the convention. Changing this after data has been entered will result in inconsistencies or possibly errors.

  • PHP_DEFAULT_TIMEZONE

    Set to a string which is a valid argument to php date_default_timezone_set() Should correspond with DB configuration. For example, "AMERICA/NEW_YORK".

  • CON_START_DATIM

    Set to mysql format date-time of the beginning of the convention. For multi-day cons, use midnight prior to the first session you want to schedule in Zambia. Changing this after data has been entered will result in inconsistencies or possibly errors.

  • DAY_CUTOFF_HOUR

    Set to an integer 0-23. Sessions beginning before this time will appear in the previous day on the grid scheduler.

  • FIRST_DAY_START_TIME

    Set to a string in 24 hour "hh:mm" format. The grid scheduler will start at this time on the first day when presenting an empty schedule.

  • OTHER_DAY_STOP_TIME

    Set to a string in 24 hour "hh:mm" format. On all but the last day, the grid scheduler will end at this time when presenting an empty schedule.

  • OTHER_DAY_START_TIME

    Set to a string in 24 hour "hh:mm" format. On all but the first day, the grid scheduler will start at this time when presenting an empty schedule.

  • LAST_DAY_STOP_TIME

    Set to a string in 24 hour "hh:mm" format. On the last day, the grid scheduler will end at this time when presenting an empty schedule.

  • STANDARD_BLOCK_LENGTH

    Set to "1:30" or "1:00". This is the default spacing on the grid scheduler.

  • DURATION_IN_MINUTES

    Set to "TRUE" or "FALSE". If true, durations on "Edit Sessions" page will appear and be interpreted as nnn minutes. If false, they will appear as h:mm. Changing this after data has been entered will result in inconsistencies or possibly errors.

  • DEFAULT_DURATION

    The format should correspond to the DURATION_IN_MINUTES setting. Typically this time is slightly less than the STANDARD_BLOCK_LENGTH with the difference being the time between sessions for travel, etc.

  • SMTP_ADDRESS

    The IP address or machine name for Zambia to send email via SMTP.

  • SMTP_PORT

    Likely options are "587", "2525", "25", or "465". See documentation for your mail relay service.

  • SMTP_PROTOCOL

    Options are "", "SSL", or "TLS". Blank/Default is no encryption. See documentation for your mail relay service.

  • SMTP_USER

    Use "" to skip authentication. See documentation for your mail relay service.

  • SMTP_PASSWORD

    Use "" to skip authentication. See documentation for your mail relay service.

  • PREF_TTL_SESNS_LMT

    Set to an integer. The limit for the partipants to set as prefered total number of sessions.

  • PREF_DLY_SESNS_LMT

    Set to an integer. The limit for the partipants to set as maximum number of sessions for any day.

  • AVAILABILITY_ROWS

    Set to an integer. The number of rows to render where participants specify their availability for particular days and times.

  • MAX_BIO_LEN

    Set to an integer. The maximum permitted length in characters for a participant biography.

  • MY_AVAIL_KIDS

    Set to TRUE or FALSE. If TRUE, activates an old, no longer used feature* on participant "Availability" page asking participants how many children they will be bringing to childrens' programming or activities.

  • ENABLE_SHARE_EMAIL_QUESTION

    Set to TRUE or FALSE. If TRUE, activates a question on participant "Profile" page asking participants if they are willing to share their email address with other participants with whom they share panels.

  • ENABLE_USE_PHOTO_QUESTION

    Set to TRUE or FALSE. If TRUE, activates a question asking participants on participant "Profile" page if they are willing to allow their photos to be taken at con and used for marketing.

  • ENABLE_BESTWAY_QUESTION

    Set to TRUE or FALSE. If TRUE, activates an old, no longer used feature* on participant "Profile" page asking participants the best way to reach them: email, phone, or postal mail.

  • BILINGUAL

    Set to "TRUE" or "FALSE". If TRUE, activates an old, no longer used feature* whereby several fields have two copies, one for each of two languages.

  • SECOND_LANG

    AS part of an old, no longer used feature* specifies name of alternate (non-English) language.

  • SECOND_TITLE_CAPTION

    AS part of an old, no longer used feature* specifies name of form caption for alternate Session title in alternate language.

  • SECOND_DESCRIPTION_CAPTION

    AS part of an old, no longer used feature* specifies name of form caption for alternate Session description in alternate language.

  • SECOND_BIOGRAPHY_CAPTION

    AS part of an old, no longer used feature* specifies name of form caption for alternate participant biography in alternate language.

  • SHOW_BRAINSTORM_LOGIN_HINT

    Set to TRUE or FALSE. This activates a hint on the login page which allows users to anonymously log in to create and view sessions as part of brainstorming process. Should be used only if brainstorm functionality is activated.

  • USER_ID_PROMPT

    The label which will be applied to the badgeid field in forms. You may want to call it "User ID" instead of "Badge ID".

  • RESET_PASSWORD_SELF

    Set to TRUE or FALSE. Whether user may reset his own password via email link. See release notes for PR 66 regarding requirements and configuration for this capability.

  • ROOT_URL

    The base URL to reach this server including trailing /. This parameter is used only for resetting password via email.

  • PASSWORD_RESET_LINK_TIMEOUT

    How long before the emailed password reset link times out. See https://www.php.net/manual/en/dateinterval.construct.php for format. This parameter is used only for resetting password via email.

  • PASSWORD_RESET_LINK_TIMEOUT_DISPLAY

    Text description of PASSWORD_RESET_LINK_TIMEOUT to explain to users. This parameter is used only for resetting password via email.

  • RECAPTCHA_SITE_KEY

    Parameter from your Google reCAPTCHA account. This parameter is used only for resetting password via email.

  • RECAPTCHA_SERVER_KEY

    Parameter from your Google reCAPTCHA account. This parameter is used only for resetting password via email.

  • PASSWORD_RESET_FROM_EMAIL

    From address to be used for password reset emails. This parameter is used only for resetting password via email.

  • ENCRYPT_KEY

    Used for encrypting hidden inputs. One suggestion for this is to use https://passwordsgenerator.net and set it to generate a 64 character alphanumeric-only password.

  • DEFAULT_USER_PASSWORD

    If your deployment creates users with a default password, specify it here.

  • TRACK_TAG_USAGE

    (This controls an option which is only partially implemented, but will be completed soon.) At large enough conventions, there is a need to divide the work of program development. Previously, this had been done by track and therefore many pages allowed searching and filtering based on track. However sessions must have one and only one track, but may have any numbers of tags. Therefore, some conventions many want to use tags instead to divide work. This parameter has four options for specifying your convention's use of track and tag:

  1. TAG_ONLY -- Track field is not used and will be hidden where possible.
  2. TAG_OVER_TRACK -- Both fields are used, but primary sorting and filtering is by Tag.
  3. TRACK_OVER_TAG -- Both fields are used, but primary sorting and filtering is by Track.
  4. TRACK_ONLY -- Tag field is not used and will be hidden where possible.

  • REQUIRE_CONSENT

    Display page to require Data Collection Consent from all users

  • USE_REG_SYSTEM

    Specifies whether Zambia users are created via an integration with a registration system. If not, then there are GUIs for creating and editing users within Zambia.

  • REG_PART_PREFIX

    If users are created within Zambia, this specifies an alphanumeric prefix to the badgeid (user id). The portion following the prefix is a number which will increment for each new user. The parameter can be empty string for no prefix.

  • CON_THEME

    If you wish customize the theming of your Zambia installation with a stylesheet, create that stylesheet and specify the path to it with this property. Note, the stylesheet will be used only on pages which have been migrated to BS4. Leave this property as "" to have no custom theming.

  • CON_HEADER_IMG

    If you wish your Zambia installation to use its own header image, specify the path to it with this property. Leave this property as "" to have no custom image.

  • CON_HEADER_IMG_ALT

    If you wish your Zambia installation to use its own header image, specify the alt text for it with this property. Leave this property as "" to have no custom image.

Vestigial Features

Features linking here have not been used, tested, or supported in many years so may not work reliably.