TetraBB.com Home of Tetra-WebBBS and TetraBB PRO

Tetra WebBBS Configuration

Variables List

• $admin_name
  $admin_name is the name of your board's administrator.  It will appear at the bottom of ...
• $AdminCloseCode
  Use $AdminCloseCode to define any HTML code that you want to appear after admin posts in the index ...
• $AdminOpenCode
  Use $AdminOpenCode to define any HTML code that you want to have appear before admin posts in the ...
• $adminurl
  $adminurl is an old variable used until 5.12. Since version 5.20 it's unused. Since 5.20 the ...
• $AllowEmailNotices
  Set $AllowEmailNotices to "1" if you want users to be able to request e-mail notifications when ...
• $AllowFramesChoice
  $AllowFramesChoice is UNUSED since 6.00 Support of internal framed setup is dropped since version ...
• $AllowHTML
  If $AllowHTML is set to "0", HTML tags will be stripped from messages posted on your forum. If ...
• $AllowNewThreads
  If $AllowNewThreads is set to "0", users will NOT be able to start new threads If $AllowNewThreads ...
• $AllowPics
  Set $AllowPics to "1" to allow users to include a link to a graphic image on their own or another ...
• $AllowPreview
  Set $AllowPreview to "1" to allow users to "preview" their posts before submitting them. Boolean 0/1
• $AllowProfileHTML
  $AllowProfileHTML works just the same as the $AllowHTML variable, only it applies to user profiles ...
• $AllowProfilePics
  $AllowProfilePics works just the same as the $AllowPics variable, only it applies to user profiles ...
• $AllowProfilePicsUpload
  If $AllowProfilePicsUpload is set to '1' visitors will be able to upload graphic images to ...
• $AllowProfiles
  If $AllowProfiles is set to '1', visitors are allowed to create a user profiles. Boolean ...
• $AllowProfileURLs
  $AllowProfileURLs works just the same as the $AllowURLs variable, only it applies to user profiles ...
• $AllowQuickinfo
  If $AllowQuickinfo is set to "1" quickinfo calls are enabled and will be executed by the forum ...
• $AllowQuickSearch
  If $AllowQuickSearch is set to '1' an input field for searching the forum is displayed to ...
• $AllowRemoveNew
  $AllowRemoveNew defines if the *Remove NEW Telltale* link is displayed on the message index ...
• $AllowReportAbuse
  If $AllowReportAbuse  is set to '1' users may report abusive posts to the forum ...
• $AllowResponses
  If $AllowResponses is set to '0', users will NOT be able to post follow-ups (responses) to ...
• $AllowSearch
  If $AllowSearch is set to '1' a link to the search form is displayed on the navigation. ...
• $AllowTellAFriend
  $AllowTellAFriend allows users to send email notification to a third party email address and inform ...
• $AllowTroubleTicket
  If $AllowTroubleTicket is set to '1' an optional link is added to the main navigation bar ...
• $AllowURLs
  Available settings: 0/1/2 Set $AllowURLs to "1" to allow users to include a URL link at the bottom ...
• $AllowUserDeletion
  Set $AllowUserDeletion to "1" if you want users to be able to include a password with their ...
• $AllowUserEditHours
  $AllowUserEditHours specifies a time period in minutes within which users are allowed to edit their ...
• $AllowUserPicsUpload
  If $AllowUserPicsUpload is set to '1', users may upload an image with their message. New in ...
• $AllowUserPrefs
  If $AllowUserPrefs is set to '0', users will NOT be able to alter the style in which ...
• $archive_subdir
  $archive_subdir is a variable to be used in admin entry scripts only. If you have set up an archive ...
• $archive_URL
  $archive_URL is an optional variable to be added to section(2) of PUBLIC entry scripts. NEW in 5.30 ...
• $ArchiveDir
  $ArchiveDir is a variable used in older WebBBS version. It's UNUSED since 5.30
• $ArchiveOnly
  $ArchiveOnly is an old variable, inherited from older WebBBS versions. Tetra-WebBBS focuses on ...
• $AutoHotlink
  If $AutoHotlink is set to '1', the script will attempt to automatically hotlink any URLs or ...
• $AutoQuote
  Boolean: 0/1 If $AutoQuote is set to "1", the new text of a message will automatically be quoted in ...
• $AutoQuoteChar
  $AutoQuoteChar defines the character(s) you want used at the beginning of "quoted" lines.
• $AutoQuoteCloseTag
  $AutoQuoteCloseTag is a new variable in 6.22. Default setting: ...
• $AutoQuoteOpenTag
  AutoQuoteOpenTag is a new variable in 6.22. Default setting: ...
• $BanLevel
  If $BanLevel is set to '0', anyone whose IP address or domain name matches an entry in the ...
• $BannedIPsFile
  $BannedIPsFile is UNUSED since 5.30 Scripts now autocreate and autosense for the file where banned ...
• $BanUnresolved
  If $BanUnresolved is set to 1, anyone whose IP address cannot be resolved to a domain name will be ...
• $BBSFrame
  $BBSFrame is UNUSED since 6.00
• $BlindEmail
  If $BlindEmail is set to '1' all users are allowed to send blind emails. If $BlindEmail is ...
• $boardname
  Set $boardname to the name of your specific discussion board. Note: You MUST define $boardname for ...
• $BottomNavbarNoPrint
  If $BottomNavbarNoPrint is set to '1', global bottom navbar will NOT get printed. Boolean ...
• $browsable_archive
  $browsable_archive is a shortcut to a set of configs optimized for less serverload. It's ...
• $BypassContentFilter
  if $BypassContentFilter is set to either '1' or '2' allows to bypass the ...
• $BypassLock
  $BypassLock is a special configuration to allow admins to run a public test forum though they ...
• $BypassPassword
  $BypassPassword is unused since version 6.00 ! Starting in version 6.00 all administrative password ...
• $BypassRefCheck
  $BypassRefCheck is part of a set of security features which attempt to catch illegal requests. If ...
• $BypassSession
  If $BypassSession is set to '1' login for admin scripts is bypassed. You may enabe this ...
• $CensorPosts
  If $CensorPosts is set to '0', a message containing forbidden words will be rejected, and ...
• $cgiurl
  Since 5.20 $cgiurl is ONLY used for admin scripts and maildigest scripts! Public entry scripts ...
• $CharSet
  $CharSet allows to specify the character set for a meta-tag sent with each page. If undefined ...
• $CompressedList
  If $CompressedList is set to  'flat' the compressed index listing will use the new ...
• $CookieLifetime
  $CookieLifetime allows for configuration of cookie expiration. New in 6.21 Optional settings:  ...
• $CookiePath
  $CookiePath is sort of a guru variable for fine tuning cookies. New in 6.21 $CookiePath is an ...
• $data_basedir
  $data_basedir is the absolute PATH to your bbs (data) root folder. New since 5.20 Be sure to define ...
• $data_subdir
  $data_subdir is the subfolder of your bbs root folder for a particular board. For example, if ...
• $DateConfig
  $DateConfig is a string defining the format in which you want dates to appear on the board. ...
• $DBMType
  $DBMType determines how the DBM (database) files will be accessed. Most users can leave it set to ...
• $DefaultTime
  $DefaultTime defines a time period used for paginating the message index. Each page of the message ...
• $DefaultType
  $DefaultType allows for configuring the display style of the message index and individual messages. ...
• $dir
  $dir is UNUSED since 5.30
• $DisallowCaching
  If $DisallowCaching is set to '1', the scripts will add some output to the HTTP-header to ...
• $DisplayAvatar
  If $DisplayAvatar is set to '1' avatar images are visible on message display pages (single ...
• $DisplayEmail
  If $DisplayEmail is set to '1', posters' e-mail addresses, if provided, will be shown ...
• $DisplayIPs
  If $DisplayIPs is set to '1', posters' IP addresses or domain names, as determined by ...
• $DisplayProfileEmail
  $DisplayProfileEmail works just the same as the $DisplayEmail variable, only it applies to user ...
• $DisplayProfiles
  If $DisplayProfiles is set to '0' poster names are not linked to the corresponding profile. ...
• $DisplayViews
  If $DisplayViews is set to '1', the script will keep track of and display in the index the ...
• $DocType
  $DocType allows to specify the DocType printed with the source code of each page sent to the ...
• $EditedProfilesModerated
  If $EditedProfilesModerated is set to '0' the moderated status of the profile stays ...
• $email_list
  Set $email_list to "0" if you don't want to set up any sort of e-mail list to notify interested ...
• $EmailNoticesCheckbox
  If $EmailNoticesCheckbox is set to '1' the checkbox for 'email me when a reply is ...
• $force_domain
  $force_domain allows to specify ONE domain to which all calls will be redirected if a different ...
• $force_moderated
  If $force_moderated is set to "1" all posts are put on hold until they are approved by the ...
• $HeaderOnly
  If $HeaderOnly is set to '1', e-mail notifications will contain only the header ...
• $HideAdminEmail
  If $HideAdminEmail is set to "0" the forums footer will contain a link to the administrator's ...
• $HourOffset
  Use $HourOffset to adjust the times shown for posts on your BBS if you're in one time zone and ...
• $html_basedir
  $html_basedir is a true Guru-setting! - Keep hands OFF if you don't know exactly what ...
• $IndexCompressedAlphaSorted
  If $IndexCompressedAlphaSorted is set to "1" compressed index lists get caseINsensitive ...
• $IndexCompressedFlatThreadPoster
  $IndexCompressedFlatThreadPoster is a special variable associated only with the new 'flat' ...
• $IndexEntryLines
  $IndexEntryLines specifies the format in which the index will be displayed. If $IndexEntryLines is ...
• $IndexSubjectNoPrefix
  $IndexSubjectNoPrefix works just the same as the $MsgThreadSubjectNoPrefix variable, but for ALL ...
• $IndexSubjectOnly
  If $IndexSubjectOnly is set to '1', on message index listing only the subject line will be ...
• $IndPaginateHeadlineNoPrint
  If $IndPaginateHeadlineNoPrint is set to *1,* the pagination will only contain links to the pages ...
• $IndTopinfNoPrint
  If $IndTopinfNoPrint is set to '1', the message index will NOT display the information ...
• $InputColumns & $InputRows
  $InputColumns and $InputRows are deprecated. Use CSS instead!
• $IsolateCookies
  By default, if you have multiple forums, they will use "shared" cookies, so that once a visitor has ...
• $Link_Telltale
  $Link_Telltale allows for an optional bit of text or HTML code to be appended to the subject of any ...
• $ListAllProfiles
  If $ListAllProfiles is set to '0', only profiles for people who have at least one message ...
• $ListBullets
  If $ListBullets is set to '0', index listings will be created with "unbulleted" lists. If ...
• $ListEmptyProfiles
  If $ListEmptyProfiles is set to '0', only those profiles will be included in the profiles ...
• $ListProfiles
  $ListProfiles defines if the *Profiles* link is displayed on the main navbar. If set to "1" the ...
• $live_subdir
  $live_subdir a special configuration variable used ONLY for entry scripts to archive boards. Set ...
• $LockRemoteUser
  $LockRemoteUser allows the control of public access to the forums by server-side authentification. ...
• $maillist_address
  Set $maillist_address to the address to be used for e-mails related to your BBS. You should define ...
• $mailprog
  $mailprog defines the mail program which the script will use. The variable can be defined in one of ...
• $MaxGraphicSize
  If you allow graphic file uploads, set $MaxGraphicSize to the maximum size (in kilobytes) of each ...
• $MaxInputLength
  Use $MaxInputLength to set the maximum length of message subjects and author names.
• $MaxMessageSize
  Set $MaxMessageSize to the maximum size (in kilobytes) of messages which can be posted. This is to ...
• $MaxPostsPerDay_DateTime
  $MaxPostsPerDay_DateTime is a special purpose variable to allow fine-tuning of ...
• $MaxPostsPerDay_Limit
  $MaxPostsPerDay_Limit allows board admins to limit the maximum number of posts a unique poster can ...
• $MaxSearchLength
  $MaxSearchLength defines the maximum length of input for searches. New since 6.00 You may wonder ...
• $Moderated
  If $Moderated is set to '1', new posts will be put "on hold" until approved by the ...
• $ModeratorRun
  If $ModeratorRun is set to '1' certain sections of the admin portal and a few links on ...
• $MsgThreadAlphaSorted
  If $MsgThreadAlphaSorted is set to '1', the responses list on message display pages will be ...
• $MsgThreadNoPrint
  $MsgThreadNoPrint is a special purpose variable for advanced users. It allows the control of the ...
• $MsgThreadParentToHeadline
  If $MsgThreadParentToHeadline is set to '1', the subjectline of the absolute parent message ...
• $MsgThreadSubjectNoPrefix
  Set $MsgThreadSubjectNoPrefix to "1" if you want to prefix each subject line with a numbering ...
• $MsgThreadSubjectOnly
  Set $MsgThreadSubjectOnly to '1', if you want the list of responses to shown only the ...
• $MsgTitleOnly
  If $MsgTitleOnly is set to '1', only the subject line get's printed as a headline to ...
• $NaughtyWordsFile
  $NaughtyWordsFile is UNUSED since 5.30 Scripts now autocreate and autosense for the file where ...
• $NewCloseCode
  Use $NewCloseCode to define any HTML code that you want to  appear after new posts in the ...
• $NewOpenCode
  Use $NewOpenCode to define any HTML code that you want to appear before new posts in the index ...
• $NewProfilesModerated
  If $NewProfilesModerated is set to '0' newly created profiles will be set to NOT being ...
• $NM_Telltale
  $NM_Telltale allows for an optional bit of text or HTML code to be appended to the subject of any ...
• $no_print_form_on_error
  $no_print_form_on_error is a special purpose configuration variable to control the display of ...
• $notification_address
  Set $notification_address to the email address on which you want to receive notification emails ...
• $NotifyAdminOnModerated
  If $NotifyAdminOnModerated is set to '1' a notification email will be sent to the email ...
• $PaginationLength
  $PaginationLength is an optional variable to configure the number of pagination links shown on ...
• $Pic_Telltale
  $Pic_Telltale allows for an optional bit of text or HTML code to be appended to the subject of any ...
• $PreEmailMessage
  $PreEmailMessage allows for optional HTML to be displayed above the "send e-mail" form. Obviously ...
• $PrepostMessage
  $PrepostMessage allows for optional HTML to display any instructions or information above the "post ...
• $printbenchmark
  If $printbenchmark is set to '1', benchmark results will be printed at the very bottom on ...
• $printboardname
  If $printboardname is set to '1', the board name will be shown at the top of ...
• $private_list
  Set $private_list to '1', if you want e-mail notices to be sent out, but don't want ...
• $ProfileColumns
  Set $ProfileColumns to the number of columns to be used in displaying the profile list.
• $ProfilesList_ActivityCutoff
  Set $ProfilesList_ActivityCutoff to a positiv integer number to limit the profiles list to only ...
• $qinfo_closecode
  Use $qinfo_closecode to insert any HTML code that you want to appear after the quickinfo links to ...
• $qinfo_linktarget
  Set $qinfo_linktarget to specify the linktarget where quickinfo links are supposed to open. If ...
• $qinfo_maxitems
  $qinfo_maxitems specifies the maximum number of items displayed with the quickinfo feature, if it ...
• $qinfo_nolinks
  If $qinfo_nolinks is set to "1" the subject line of posts listed on quickinfo displays will NOT be ...
• $qinfo_opencode
  Use $qinfo_opencode to insert any HTML code that you want to appear before the quickinfo links to ...
• $qinfo_subject_length
  $qinfo_subject_length works pretty much the same like $qinfo_teaserlength, only it applies to the ...
• $qinfo_subject_only
  If $qinfo_subject_only is set to "1" quickinfo links will only hold a subject line of the post. ...
• $qinfo_teaserimage
  $qinfo_teaserimage works pretty much the same like $teaser_image, only it applies to quickinfo ...
• $qinfo_teaserlength
  $qinfo_teaserlength works pretty much the same like $teaser_length, only it applies to quickinfo ...
• $RefreshTime
  Set $RefreshTime to the number of seconds that the various notification screens ("Your message has ...
• $ReparentNoRestrict
  $ReparentNoRestrict is UNUSED since 6.10.
• $ReplyToAddress
  Set $ReplyToAddress to the email address which you want to be used for the "Reply-To" headers of ...
• $RequireEmail
  If $RequireEmail is set to '1', an email address must be provided for posting a message. If ...
• $RequireProfile
  If $RequireProfile is set to '1', visitors will only be able to post to the forum if they ...
• $RequireProfileEmail
  If $RequireProfileEmail is set to '1', anyone attempting to create a profile must provide a ...
• $ResolveIPs
  If $ResolveIPs is set to '1', posters' IP addresses will be resolved to domain names. ...
• $SaveLinkInfo
  If $SaveLinkInfo is set to '1', any information provided in the optional link and image ...
• $scripts_dir
  $scripts_dir is UNUSED since 5.30 It's replaced by usage of Perl's built-in 'use lib ...
• $SE_no_profiles
  $SE_no_profiles helps to protect your users privacy and keep their profiles from being indexed by ...
• $SE_no_teaser
  $SE_no_teaser is a setting helping to control server load. 0 - Teasers will be displayed, ...
• $SE_title_only
  $SE_title_only is another optional feature helping to protect your users privacy by NOT displaying ...
• $SearchFriendlyProfiles
  $SearchFriendlyProfiles is replaced by $SE_no_profiles since 6.10. In Tetra-WebBBS 6.10 a lot of ...
• $SearchFriendlyURLs
  If $SearchFriendlyURLs is set to 0, the script will generate URLs using standard QUERY_STRING. If ...
• $SearchURL
  $SearchURL should be left undefined, as the search facilities built into Tetra-WebBBS are ...
• $SepPostFormIndex and $SepPostFormRead
  $SepPostFormIndex and $SepPostFormRead determine if "post message" forms will appear on the index ...
• $SessionTime
  Set $SessionTime to the time (in minutes) that a visitor must be absent from the forum before a ...
• $SFU_base_chars
  $SFU_base_chars takes effect ONLY, if $SFU_subject is enabled! New in 6.10 $SFU_base_chars is a ...
• $SFU_pseudo_fileextension
  $SFU_pseudo_fileextension takes effect ONLY, if $SFU_subject is enabled and $SearchFriendlyURLs is ...
• $SFU_redirects
  $SFU_redirects takes effect ONLY, if $SFU_subject is enabled! If $SFU_redirects is set to ...
• $SFU_subject
  $SFU_subject and all the other related $SFU_*** variables build a set of optional configurations to ...
• $SFU_word_delimiter
  $SFU_word_delimiter takes effect ONLY, if $SFU_subject is enabled! $SFU_word_delimiter is an ...
• $ShareAdminPassword
  $ShareAdminPassword is UNUSED since 6.00. $ShareAdminPassword was a variable temporarily used for ...
• $shortboardname
  $shortboardname allows to define a shorter version of your forum's name to be used in the ...
• $ShowPosterIP
  If $ShowPosterIP is set to '1', when a visitor posts a message, the "thanks for posting" ...
• $SingleLineBreaks
  If $SingleLineBreaks is set to '0', single line breaks will be ignored. This option is ...
• $SingleMsgWrapNoUse
  Set $SingleMsgWrapNoUse to '1' if you DON'T want the single message wrapper to be used ...
• $SMTP_PASSWORD
  Set $SMTP_PASSWORD to the password of your SMTP server if authentification is required to access ...
• $SMTP_SERVER
  $SMTP_SERVER is the name/address of your SMTP server. Your host will provide this name/address. If ...
• $SMTP_USER
  Set $SMTP_USER to the name you use to send emails via your SMTP server. If you don't know what ...
• $SpamScore
  Set $SpamScore to any positive (integer) number. It servs as a cutoff for identifying spam when ...
• $SpellCheckURL
  Set $SpellCheckURL to the URL of the WBOSS spellchecker installed on your server. New since 6.00 ...
• $SSIDebug
  If $SSIDebug is set to '1', Tetra-WebBBS will print "SSI TAG NOT SUPPORTED" in place of any ...
• $teaser_ajax
  Settings $teaser_ajax to '1' enables dynamically requested teasers on the message index. ...
• $teaser_check_endmark
  If $teaser_check_endmark is set to '1', optional markers can be added to the messagetext to ...
• $teaser_html
  If $teaser_html is set to '0' or is undefined, HTML will be stripped from teasers. If ...
• $teaser_image
  $teaser_image allows to use the image associated with a message to be displayed on the message ...
• $teaser_length
  Set $teaser_length to a positive integer number to enable teasers to be displayed on the message ...
• $teaser_max
  $teaser_max allows to define the maximum number of items on the message index for which teasers are ...
• $teaser_new_only
  If $teaser_new_only is set to '1', teasers are shown only for messages NEW since last ...
• $ThreadSpacer
  $ThreadSpacer allows for an optional bit of text or HTML code to be inserted between threads in the ...
• $tmpl_subdir
  $tmpl_subdir specifies a subfolder of $data_basedir/_tmpl. NEW in 5.30 Looking for a template the ...
• $TopNavbarNoPrint
  If $TopNavbarNoPrint is set to '1', the global top navbar will NOT get printed. Boolean 0/1 ...
• $TopNPosters
  If $TopNPosters is set to a positive integer number, visitors will be able to access a statistics ...
• $use_semaphore_lock
  If $use_semaphore_lock is set to '1' file locking routines based on the flock() command are ...
• $UseCookies
  If $UseCookies is set to '1', the usage of "cookies" will be implemented. Boolean: 0/1 ...
• $UseFrames
  $UseFrames is UNUSED since 6.00
• $UseLocking
  $UseLocking is UNUSED since 5.30
• $UserPicsDir & $UserPicsURL
  $UserPicsDir & $UserPicsURL are UNUSED since 5.30 Scripts now are autoconfiguring and ...
• $UserProfileDir
  $UserProfileDir is UNUSED since 5.30 Profiledata is now stored in default folder /_profiles ...
• $UserProfilePicsDir & $UserProfilePicsURL
  $UserProfilePicsDir & $UserProfilePicsURL are UNUSED since 5.30 Profileimages are now stored in ...
• $WEB_SERVER
  $WEB_SERVER is UNUSED since 5.30
• $WelcomePage
  $WelcomePage is UNUSED since 6.00
• %Admin_Navbar_Links
  %Admin_Navbar_Links is a hash variable to define extra links to be displayed only on the main ...
• %extrachars
  %extrachars is an old variable that NEVER worked as expected and finally was eliminated in 5.30.
• %FormatCode
  %FormatCode is a hash variable intended to allow certain basic formatting functions made available ...
• %Navbar_Links
  %Navbar_Links is a hash variable to define the names and URLs of any "extra" links to appear in the ...
• %parking_folders
  %parking_folders is a hash variable to allow for configuration of parking folders. New since 6.00 ...
• %QueryMode
  %QueryMode is a hash variable to define your own query strings to replace some default query ...
• %QuickPrefs
  If %QuickPrefs is defined dropdown boxes for quick selection of preferences are displayed in the ...
• %SFU_char_mapping
  %SFU_char_mapping is a hash variable which allows boardadmins to define rules for substitution of ...
• %SmileyCode
  %SmileyCode is a hash variable of some "codes" which will be converted when they appear in the ...
• @allowed_remote_users
  @allowed_remote_users is an array variable which allows the control of access to admin entry ...
• @any_dbm
  @any_dbm is an array variable which allows site owners to define which DBM database module is used ...
• @SubjectPrefixes
  @SubjectPrefixes takes a list of "mandatory" subject prefixes. Those posting starting a new thread ...
• Deprecated variables since 5.2x
  Variables deprecated because the locations and names of the folders and files are now defaults: ...