Forum Discussion

Mike_Maher's avatar
Mike_Maher
Icon for Nimbostratus rankNimbostratus
Aug 10, 2007

Examples of default .inc file?

I am starting to try and do some customizing of some of the errors messages for Firepass, using WebDav. I have looked through AskF5 and the online documentation (which only contains the index file), but I have been unable to find where there is examples of the default configuration of all the .inc files that are available for customization. Does anyone know if this documentation exsists? Not being an avid web programmer I would like to be able to view what the default configuration of these files are before creating my own.

3 Replies

  • I never found any examples or documentation other than what is in the helpfile. Basically take an HTM file and rename it to the appropriate inc file. This is what has worked for us.
  • online help from FirePass has some info:

     

     

    To enable WebDAV based customization

     

     

    1. Create an HTTP web service on the Device Management : Configuration : Network Configuration : Web Services screen.

     

    2. Select the Allow insecure access option on the Device Management : Security : User Access Security screen.

     

    3. Check Allow WebDAV sandbox customization on the the Device Management : Customization screen and enter a WebDAV password in the text box that appears.

     

     

    The WebDAV sandbox is accessed via HTTP at the URI /sandbox as the user webdav. So, for example, if the FirePass controller has been configured using the steps above with a HTTP web service at 192.168.0.99, you would use the URL http://192.168.0.99/sandbox/.

     

    Sandbox files

     

     

    You can place any content in the sandbox directory. The FirePass controller uses specific files to override or supplement stock system behavior, as follows:

     

     

    *

     

     

    index.htm: Represents content that appears when a user requests the root URI (/). Typically the user is redirected to /my.logon.php3, to which the customized page may provide a link. View code for an example index.htm page.

     

    *

     

     

    blocked_popups_warning.htm: This page presents a warning to a user when a popup window is blocked by the browser. The content should describe how to disable the popup blocker, for example, right-click and choose "Allow popups for this page." The messages vary depending on the browser and your own system configuration, so be sure to customize the message to your own configuration. To improve the user experience, we recommend that you add the following HTML code:

     

     

    This code allows the user to retry the popup page after taking action to allow the popup.

     

    * customfoot.inc: Represents content that serves as the common footer information that appears at the bottom of the user logon page.

     

    * exception.inc: This page provides a custom error message to a user when a web page is denied, or when a web portal cannot load. You can use the following variables in the exception.inc file:

     

    o %F5_MSG_TITLE% – replaces this variable with the title of the error message

     

    o %F5_MSG% – replaces this variable with the text of the error message

     

    o %F5_URL% – replaces this variable with the URL that caused the error

     

     

    For example, a simple html file for exception.inc is included below:

     

     

     

     

    Custom error page

     

    %F5_MSG_TITLE%

     

    Error message: %F5_MSG%

     

     

    URL: %F5_URL%

     

     

     

     

    * right.inc: Represents content that appears to the right of the user logon prompt on the front page.

     

    * links.inc: Represents content that appears immediately below the user logon prompt and replaces the set of default links displayed under the title Need Help.

     

    * links.pocket.inc: Represents content that is the same as links.inc, but appears for PocketPC clients.

     

    * lockoutmsg.inc: Represents content that is displayed to users attempting to log in while the administrator has the Lockout New User Sessions option enabled under the Device Management : Maintenance : User Session Lockout screen.

     

    * logon.denied.inc: Directs the user to logon denied page when he fails a pre-logon sequence check; for example, the user does not have the required antivirus software or firewall.

     

    * logon.failed.inc: Directs the user to a failed logon page when the user enters incorrect credentials or cannot authenticate on the external server. This page can contain a logon form that allows the user to relogon.

     

    * logout.inc: Represents content that is displayed to users upon logout or session termination.

     

    * resetpass.inc: Represents content that appears in response to a click on the Forgot Password? link when the user's password is not maintained in the FirePass controller database (for example, on an external LDAP server instead). The presence of the Forgot Password? link is governed by settings in User Password Recovery under Security in the Device Management section.

     

     

    All content in the sandbox directory is mapped to a virtual folder /sandbox that is accessible from all web services. Content added to the files listed above can reference other files in the sandbox directory. For example, a necessary security download may be stored on the FirePass controller sandbox directory and then referenced from other customized content. For sample implementation text that provides portal access, see the Supporting portal access sample section.
  • I will mess with that, does anyone have an example from resetpass.inc and logon.failed.inc ?????