TetraBB.com Home of Tetra-WebBBS and TetraBB PRO

Tetra-WebBBS Configs

This board holds an alphasorted list of all configuration variables available for trimming your Tetra-WebBBS forums to fit your site's needs.
Please note: All variables starting with either "@" or "%" to be found at the end of this list due to alphasorting ;).

Those seeking information on setup of Tetra-WebBBS please check out the documentation board.
 

• $admin_name
  The name of your board's administrator. It will appear at the bottom of script-generated pages ...
• $AdminCloseCode
  Any HTML code that you want to have appear after admin posts in the index listing. Note: ...
• $AdminOpenCode
  Any HTML code that you want to have appear before admin posts in the index listing. By default, a ...
• $adminurl
  - old variable until 5.12 - UNUSED since 5.20 Since 5.20 the scripts all use autodetect their URL ...
• $AllowEmailNotices
  Boolean: 0/1 Set this to "1" if you want users to be able to request e-mail ...
• $AllowFramesChoice
  NOTE: Support of frames is considered to become deprecated for versions past 5.30. So better *not* ...
• $AllowHTML
  Available settings: 0/1/2 If it's set to "0", HTML tags will be stripped from messages ...
• $AllowNewThreads
  Boolean: 0/1 If you set this variable to "0", users will NOT be able to start new ...
• $AllowPics
  Boolean: 0/1 Set this to "1" to allow users to include a link to a graphic image on ...
• $AllowPreview
  Boolean 0/1 Set this to "1" to allow users to "preview" their posts before ...
• $AllowProfileHTML
  Available settings: 0/1/2 Works just the same as the $AllowHTML variable, only it applies to user ...
• $AllowProfilePics
  Boolean: 0/1 Works just the same as the $AllowPics variable, only it applies to user profiles ...
• $AllowProfilePicsUpload
  Boolean 0/1 New since 5.20 To allow visitors to upload graphic images to your server to be ...
• $AllowProfiles
  Boolean 0/1 To allow visitors to create user profiles, set this variable to "1". A ...
• $AllowProfileURLs
  Boolean: 0/1 Works just the same as the $AllowURLs variables, only it applies to user profiles ...
• $AllowQuickinfo
  Boolean: 0/1 New in 5.31 If this variable is set to "1" quickinfo calls are enabled and will be ...
• $AllowResponses
  Boolean: 0/1 If you set this variable to 0, users will NOT be able to post follow-ups (responses) ...
• $AllowURLs
  Boolean: 0/1 Set this to "1" to allow users to include a URL link at the bottom of their ...
• $AllowUserDeletion
  Boolean: 0/1 Set this to "1" if you want users to be able to include a password with ...
• $AllowUserEditHours
  New in 5.31. To allow users to edit their posts set this variable to a floating point number ...
• $AllowUserPicsUpload
  Boolean 0/1 New since 5.20 To allow users to upload an image with their message, set this variable ...
• $AllowUserPrefs
  Boolean: 0/1 If you set this variable to 0, users will NOT be able to alter the style in which ...
• $archive_subdir
  New since 5.30 Replacement for the old $ArchiveDir variable. Optional setting for section(2) of ...
• $archive_URL
  NEW in 5.30 Optional variable to be added to section(2) of PUBLIC config.pl files. If you have set ...
• $ArchiveDir
  Old variable. UNUSED since 5.30
• $ArchiveOnly
  If this variable is set to 0, the board will function normally. If it's set to 1, instead of the ...
• $AutoHotlink
  Boolean: 0/1 If you set this variable to 1, the script will attempt to automatically hotlink any ...
• $AutoQuote
  Boolean: 0/1 If this variable is set to "1", the new text of a message will ...
• $AutoQuoteChar
  The character you want used at the beginning of "quoted" lines.
• $BanLevel
  Available settings: 0/1/2 If this variable is set to 0, anyone whose IP address or domain name ...
• $BannedIPsFile
  UNUSED since 5.30 Scripts are autocreating and autosensing for BannedIPsFile. No need to define ...
• $BanUnresolved
  Boolean: 0/1 If this variable is set to 1, anyone whose IP address cannot be resolved to a domain ...
• $BBSFrame
  If you're using Tetra-WebBBS with frames within another frameset, define this with the name of the ...
• $BlindEmail
  Boolean: 0/1 If you want to allow visitors to e-mail the posters but want to maintain the privacy ...
• $boardname
  The name of your specific discussion board. You MUST define this variable for cookies and certain ...
• $BottomNavbarNoPrint
  Boolean 0/1 New since 5.20 If set, global bottom navbar will not get printed
• $browsable_archive
  Available settings: 0/1/2 NEW in 5.30 $browsable_archive is a shortcut to a set of configs ...
• $BypassLock
  Boolean 0/1 New since 5.31 A special configuration to allow admins to run a public test forum ...
• $BypassPassword
  Boolean: 0/1 If you've stored your admin_config in a password-protected directory, set this ...
• $CensorPosts
  Available settings: 0/1/2 If this variable is set to 0, a message containing forbidden words will ...
• $cgiurl
  For public scripts: - old variable, unused since 5.20 For admin scipts and maildigest script still ...
• $CharSet
  New since 5.20 Allows to specify the character set for a meta-tag sent with each page. If ...
• $data_basedir
  New since 5.20 The absolute PATH to your bbs (data) root folder. Be sure to define this variable ...
• $data_subdir
  New since 5.20 The path to a subfolder of bbs root folder for a particular board. For example, if ...
• $DateConfig
  A string defining the format in which you want dates to appear on the board. The codes available ...
• $DBMType
  This variable determines how the DBM (database) file used for storage of index information will be ...
• $DefaultTime
  $DefaultTime defines a time period used for paginating the message index. Each page of the message ...
• $DefaultType
  Tetra-WebBBS displays default to a simple chronological display of the message index. $DefaultType ...
• $dir
  - old variable until 5.12 - deprecated in 5.2x - UNUSED since 5.30
• $DisallowCaching
  Boolean 0/1 New since 5.20 If set to true the script will add some output to HTTP-header to forbid ...
• $DisplayEmail
  Boolean: 0/1 If you leave this variable defined as 1, posters' e-mail addresses, if provided, will ...
• $DisplayIPs
  Boolean: 0/1 If this variable is set to 1, posters' IP addresses or domain names, as determined by ...
• $DisplayProfileEmail
  Boolean: 0/1 New in 5.30 Works just the same as the $DisplayEmail variable, only it applies to ...
• $DisplayViews
  Available settings: 0/1/2 If this variable is set to 1, the script will keep track of and display ...
• $DocType
  New since 5.20 Allows to specify the DocType printed with the source code of each page sent to the ...
• $email_list
  Available settings: 0/1/2 Set this variable to "0" if you don't want to set up any sort ...
• $force_moderated
  Boolean 0/1 New in 5.31 If this variable is set to "1" all posts are put on hold until they are ...
• $HeaderOnly
  Boolean: 0/1 If you set this variable to 1, e-mail notifications will contain only the header ...
• $HideAdminEmail
  Boolean 0/1 New since 5.30 If this variable is set to "0" the forums footer will contain ...
• $HourOffset
  If you're in one time zone and your Web host is in another, use this variable to adjust the times ...
• $html_basedir
  NEW in 5.30 Note: This is a true Guru-setting! - Keep hands OFF if you don't know exactly what ...
• $IndexCompressedAlphaSorted
  Boolean 0/1 New since 5.20 If set to "1" compressed index lists get caseINsensitive ...
• $IndexEntryLines
  Available settings: 1 / 2 / news The format in which the index should be displayed. If this ...
• $IndexSubjectNoPrefix
  Boolean 0/1 New since 5.20 Same as $MsgThreadSubjectNoPrefix but for ALL subject lines on the ...
• $IndexSubjectOnly
  Boolean 0/1 New since 5.20 On message index listing only the subject line will be printed (Same as ...
• $IndPaginateHeadlineNoPrint
  Boolean 0/1 NEW in 5.30 Guru-setting - Keep hands OFF unless you know what you're doing! If set ...
• $IndTopinfNoPrint
  Boolean 0/1 NEW in 5.30 If set to "1" the message index will NOT display the information ...
• $InputColumns & $InputRows
  Deprecated. Use CSS!
• $IsolateCookies
  Boolean: 0/1 By default, if you have multiple forums, they will use "shared" cookies, so ...
• $Link_Telltale
  An optional bit of text or HTML code to be appended to the subject of any message containing a ...
• $ListAllProfiles
  Boolean: 0/1 If this variable is set to 0, only profiles for people who have at least one message ...
• $ListBullets
  Available settings: 0/1/2 If set to 0 index listings will be created with "unbulleted" ...
• $ListEmptyProfiles
  Boolean: 0/1 If this variable is set to 0 only those profiles will be included in the profiles ...
• $live_subdir
  This is a special configuration variable used ONLY for archive's config.pl files. Set this ...
• $LockRemoteUser
  Boolean: 0/1 If your Tetra-WebBBS script is password protected via .htaccess or another system ...
• $maillist_address
  The address to be used for e-mail related to your BBS. You should define this variable even if you ...
• $mailprog
  The mail program the script will use. The variable can be defined in one of three ways. The ...
• $MaxGraphicSize
  If you allow graphic file uploads, define here the maximum size (in kilobytes) of each file that ...
• $MaxInputLength
  The maximum length of message subjects and author names.
• $MaxMessageSize
  The maximum size (in kilobytes) of messages which can be posted. This is to prevent users from ...
• $Moderated
  If you set this variable to 1, new posts will be put "on hold" until approved by the ...
• $MsgThreadAlphaSorted
  Boolean 0/1 New since 5.20 The responses listi shown on message display will be alphasorted (case ...
• $MsgThreadParentToHeadline
  Boolean 0/1 New since 5.20 Guru-setting Turns the subjectline of the absolute parent message of ...
• $MsgThreadSubjectNoPrefix
  Boolean 0/1 New since 5.20 Additional feature extending the use of $MsgThreadAlphaSorted. Set this ...
• $MsgThreadSubjectOnly
  Boolean 0/1 New since 5.20 Set this variable to 1, if you want the list of responses to shown only ...
• $MsgTitleOnly
  Boolean 0/1 New since 5.20 If set to "1", only the subject line get's printed as a ...
• $NaughtyWordsFile
  UNUSED since 5.30 Scripts are autocreating and autosensing for NaughtyWordsFile. No need to define ...
• $NewCloseCode
  Any HTML code that you want to have appear after new posts in the index listing. Note: ...
• $NewOpenCode
  Any HTML code that you want to have appear before new posts in the index listing. By default, a ...
• $NM_Telltale
  An optional bit of text or HTML code to be appended to the subject of any message which does not ...
• $notification_address
  If you send out e-mail notices, they will be addressed "From:" the $maillist_address, ...
• $PaginationLength
  New in 5.31 This is an optional variable to configure the number of pagination links shown at the ...
• $Pic_Telltale
  An optional bit of text or HTML code to be appended to the subject of any message which includes ...
• $PreEmailMessage
  If you're using the "blind e-mail" feature, to display any message above the "send ...
• $PrepostMessage
  To display any instructions or information above the "post new message" form, define the ...
• $printbenchmark
  Boolean 0/1 New since 5.20 If set to '1' benchmark results will be printed at the very bottom on ...
• $printboardname
  Boolean: 0/1 If this variable is set to 1, the board name will be shown at the top of the ...
• $private_list
  Boolean: 0/1 If you want e-mail notices to be sent out, but don't want just any visitors to be ...
• $ProfileColumns
  The number of columns to be used in displaying the profile list.
• $ProfilesList_ActivityCutoff
  new in 5.30 Set to a positiv number will cause the profiles list to only display those profiles, ...
• $qinfo_closecode
  New in 5.31 Any HTML code that you want to appear after the quickinfo links to forum messages. Do ...
• $qinfo_linktarget
  New in 5.31 Set this variable to specify window/frame where quickinfo links are supposed to open. ...
• $qinfo_opencode
  New in 5.31 Any HTML code that you want to appear before the quickinfo links to forum messages. Do ...
• $qinfo_subject_length
  New in 5.31 This variable works pretty much the same like $qinfo_teaserlength, only it applies to ...
• $qinfo_subject_only
  Boolean 0/1 New in 5.31 If set to "1" quickinfo links will only hold a subject line of the post. ...
• $qinfo_teaserimage
  Boolean 0/1 New in 5.31 This variable works pretty much the same like $teaser_image, only it ...
• $qinfo_teaserlength
  New in 5.31 This variable works pretty much the same like $teaser_length, only it applies to ...
• $RefreshTime
  The number of seconds that the various notification screens ("Your message has been ...
• $ReparentNoRestrict
  Boolean 0/1 New since 5.20 If set to "1" allows to *reparent* a messages and it's ...
• $ReplyToAddress
  If you leave this variable undefined, the "Reply-To:" address in e-mail notifications ...
• $RequireEmail
  Boolean 0/1 changed in 5.30 $RequireEmail defines if an email address must be provided for ...
• $RequireProfile
  Boolean: 0/1 If you set this variable to 1, visitors will only be able to post to the forum if ...
• $RequireProfileEmail
  Boolean: 0/1 If you set this variable to 1, anyone attempting to create a profile must provide a ...
• $ResolveIPs
  Boolean: 0/1 If this variable is set to 1, posters' IP addresses will be resolved to domain names. ...
• $SaveLinkInfo
  Boolean: 0/1 If you set this variable to 1, any information provided in the optional link and ...
• $scripts_dir
  - old variable until 5.22 - UNUSED since 5.30 replaced by 'use lib ...' in section(2) of entry ...
• $SearchFriendlyProfiles
  Boolean 0/1 , defaults to 0 New in 5.30 (FINAL) 0 - disallows profiles to be accessed by ...
• $SearchFriendlyURLs
  Boolean: 0/1 If this variable is set to 0, the script will generate URLs using standard ...
• $SearchURL
  This variable should be left undefined, as the search facilities built into Tetra-WebBBS are ...
• $SepPostFormIndex and $SepPostFormRead
  Boolean: 0/1 These variables determine whether "post message" forms will appear on the ...
• $SessionTime
  The time (in minutes) that a visitor must be absent from the forum before a "new visit" ...
• $ShareAdminPassword
  Boolean 0/1 new in 5.30 If this variable is set to "1", multiple forums will share the ...
• $shortboardname
  A shorter version of your forum's name to be used in the subject lines of e-mail notifications of ...
• $ShowPosterIP
  Boolean: 0/1 If you set this variable to 1, when a visitor posts a message, the "thanks for ...
• $SingleLineBreaks
  Tetra-WebBBS automatically recognizes a double line break or an indentation (either a tab or ...
• $SingleMsgWrapNoUse
  Boolean 0/1 New since 5.20 On single message screen there is a wrapping div (#msg_wrap) around all ...
• $SMTP_PASSWORD
  If your SMTP server requires authentification input here the password to access the SMTP server.
• $SMTP_SERVER
  This is the name/address of your SMTP server. Your host will provide this name/address. If you ...
• $SMTP_USER
  Set this to the name you use to send emails via your SMTP server. If you don't know what your ...
• $SSIDebug
  Boolean: 0/1 Tetra-WebBBS will attempt to interpret any SSI tags contained in your header and ...
• $teaser_check_endmark
  Boolean 0/1 New in 5.30 Guru-setting - Keep hands off unless you know EXACTLY what you're doing! ...
• $teaser_html
  Boolean 0/1 New in 5.30 GURU-setting - Keep hands off unless you know EXACTLY what you're doing! ...
• $teaser_image
  New in 5.30 Accepted values: 0/1/2 Guru-setting - Keep hands OFF unless you know what you're ...
• $teaser_length
  new in 5.30 To enable teasers to be displayed on the message index set this variable to a positive ...
• $teaser_new_only
  Boolean 0/1 New in 5.30 If this variable is set to "1" teasers are shown only for messages NEW ...
• $ThreadSpacer
  An optional bit of text or HTML code to be inserted between threads in the index listing. (It can ...
• $tmpl_subdir
  NEW in 5.30 This variable specifies a subfolder of $data_basedir/_tmpl . Looking for a template ...
• $TopNavbarNoPrint
  Boolean 0/1 New since 5.20 If this variable is set to "1", the global top navbar will not be shown.
• $TopNPosters
  If you define this variable (with a number,) visitors will be able to access a statistics page ...
• $UseCookies
  Boolean: 0/1 If this variable is set to "0", the use of "cookies" will not be implemented. If it ...
• $UseFrames
  Set this to "horizontal" (or "horiz" or "h") if you want an upper frame for the message index and ...
• $UseLocking
  UNUSED since 5.30
• $UserPicsDir & UserPicsURL
  UNUSED since 5.30 Images uploaded with messageposting form using the built-in upload function are ...
• $UserProfileDir
  UNUSED since 5.30 Profiledata is now stored in default folder /_profiles (subfolder to ...
• $UserProfilePicsDir & UserProfilePicsURL
  UNUSED since 5.30 Profileimages are now stored in default folder /webbbs/_profileimages Scripts ...
• $WEB_SERVER
  Old variable. UNUSED since 5.30
• $WelcomePage
  If you're using Tetra-WebBBS with frames, you can define this variable with the URL of a page you ...
• %extrachars
  Old variable that NEVER worked as expected. UNUSED since 5.30
• %FormatCode
  This variable is intended to be used to allow certain basic formatting functions be made available ...
• %Navbar_Links
  Use this hash variable to define the names and URLs of any "extra" links to appear in ...
• %QueryMode
  Use this hash variable to define your own query strings to replace these default query ...
• %SmileyCode
  A list of "codes" which will be converted when they appear in the subject or body of a message. It ...
• @SubjectPrefixes
  If you defined a list of "mandatory" subject prefixes here, those posting on your forum will have ...
• Deprecated variables since 5.2x
  Variables deprecated because the locations and names of the folders and files are now defaults: ...