[ Documentation index -- Welcome page ]

PHP Flat File Guestbook Documentation

Configurable Settings

To change some of the Guestbook settings, open the file 'ffgb_config.php' from the 'www' folder in a plain-text editor (for example Windows Notepad) and find the line that begins define("SETTING_NAME", ... Where SETTING_NAME is the Configurable Setting you wish to change, and change the value between the comma ',' and the end bracket ')' for a suitable value (see the list below).

  • ADMIN_USER

    The username to log in to the Administrative area. The value provided should include only letters, numbers, spaces and underscores, and should be enclosed inside speach marks (for example: define("ADMIN_USER", "MrAdmin"); would set the username for the Admin section to MrAdmin).

  • ADMIN_PASS

    The password to log in to the Administrative area. The value provided should include only letters, numbers, spaces and underscores, and should be enclosed inside speach marks (for example: define("ADMIN_PASS", "qwerty"); would set the username for the Admin section to qwerty).

  • COMMENTS_REQUIRE_VALIDATION

    Whether or not comments must be validated by the Guestbook owner before being displayed to visitors. This can help prevent spam or abuse of the Guestbook, if needed. (For example: define("COMMENTS_REQUIRE_VALIDATION", true); would mean all comments would have to be activated from within the Administration area to be viewable).

  • COMMENTS_REQUIRE_CAPTCHA

    If set to true, visitors must complete a CAPTCHA challenge when attempting to sign the guestbook. Requires a (free) reCAPTCHA account ( https://www.google.com/recaptcha/admin/create) and the settings COMMENTS_CAPTCHA_PUBLICKEY and COMMENTS_CAPTCHA_PRIVATEKEY to be set (For example: define("COMMENTS_REQUIRE_CAPTCHA", true); would mean visitors would be shown a CAPTCHA field with the normal "Port Comment" form).

  • COMMENTS_CAPTCHA_PUBLICKEY

    The Public Key provided in your reCAPTCHA profile. This must be enclosed within speach marks, and must be set if COMMENTS_REQUIRE_CAPTCHA is set to true (For example: define("COMMENTS_CAPTCHA_PUBLICKEY", "xxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxx"); where the string of x's are replaced by the public key copied from your reCAPTCHA account).

  • COMMENTS_CAPTCHA_PRIVATEKEY

    The Private Key provided in your reCAPTCHA profile. This must be enclosed within speach marks, and must be set if COMMENTS_REQUIRE_CAPTCHA is set to true (For example: define("COMMENTS_CAPTCHA_PRIVATEKEY", "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"); where the string of x's are replaced by the private key copied from your reCAPTCHA account).

  • COMMENTS_REQUIRE_EMAIL

    Whether or not comments require a valid email address in order to be accepted. If this is set to false the visitor can either post an email address or leave the field blank (For example: define("COMMENTS_REQUIRE_EMAIL", true); would mean all comments would need a valid email address to be supplied with them).

  • COMMENTS_SHOW_EMAIL

    If a valid email address is supplied with a comment and this setting is true, the comment will have the email address shown with it, as well as a "mailto:" link. If set to false, the email address will not be made public.

  • COMMENTS_ACCEPT_URL

    If set to true, the visitor can also post a URL to their website with their comment. If set to false, the URL is not asked for.

  • COMMENTS_SHOW_URL

    If set to true and a comment has had a valid URL supplied with it, the visitors URL will be displayed with their comment. If set to false, the URL will not be shown, even if present.

  • COMMENT_MAX_LENGTH

    The maximum length (in characters) of the comment the visitor can post on your Guestbook. Longer comments will not be accepted and the visitor will be shown an error message. Minimum message length is 3 characters (for example: define("COMMENT_MAX_LENGTH", 1000); sets the maximum number of characters in a comment to 1000).

  • SUBJECT_MAX_LENGTH

    The maximum length (in characters) of the subject the visitor can supply for their comment. The visitor can choose not to supply any subject if they do not wish to.

  • ACCEPT_NEW_COMMENTS

    true or false; should the guestbook accept new comments from visitors? You may wish the disable the posting of new comments for maintenance or if you will be unable to manage your website for a while, in which case you can set ACCEPT_NEW_COMMENTS to false.

  • COMMENTS_PER_BOOK

    The maximum number of visitor comments stored in a Guestbook file. This is also the maximum number of comments that may be shown per page of your Guestbook to visitors.

  • EMAIL_NEW_COMMENTS

    true or false; if true, you will be automatically emailed at the configurable address EMAIL_TO every time a new user comment is posted on the Guestbook.

  • EMAIL_TO

    The address on which you will be alerted of a new comment being posted if the configurable setting EMAIL_NEW_COMMENTS is set to true (for example: define("EMAIL_TO", "admin@where-ever.com"); will send an email notification to admin@where-ever.com when a new comment is posted).