Operation: Captive Portal Appearance
Description: Customize the appearance of the Captive Portal page. 

Sample Configuration
<WebAuthentication> <CaptivePortalAppearance> <UseCustomLayout>Enable/Disable</UseCustomLayout> <DefaultLayout> <Logo>Default/Custom</Logo> <LogoImage>Path of file</LogoImage><!-- for custom logo --> <LogoLink>http://www.example.com.com</LogoLink> <UserPrompt>Sign in to access this network</UserPrompt> <LoginPageHeaderHTML>HTML</LoginPageHeaderHTML><!-- HTML Input supported in this field--> <LoginPageFooterHTML>HTML</LoginPageFooterHTML><!-- HTML Input supported in this field--> <UsernameFieldLabel>Username</UsernameFieldLabel> <PasswordFieldLabel>Password</PasswordFieldLabel> <LoginButtonLabel>Sign in</LoginButtonLabel> <LogoutButtonLabel>Sign out</LogoutButtonLabel> <UserPortalLinkLabel>Access the User Portal</UserPortalLinkLabel> <RegistrationLinkLabel>Register for internet access</RegistrationLinkLabel> <BackgroundColor>FAFAFA</BackgroundColor> <PageTitleBackgroundColor>055BB5</PageTitleBackgroundColor> <UserPortalLinkFontColor>1987CB</UserPortalLinkFontColor> <UserPromptFontColor>055BB5</UserPromptFontColor> <HeaderFooterFontColor>5C5C5C</HeaderFooterFontColor> </DefaultLayout> <CustomLayout> <UserDefinedTemplate>HTML</UserDefinedTemplate> <SystemGeneratedHtml>HTML</SystemGeneratedHtml> </CustomLayout> </CaptivePortalAppearance> </WebAuthentication>



Parameter Mandatory Default Description
RegistrationLinkLabelNo Register for internet access 
Specify the label to be displayed for the registration link.
RegistrationLinkLabel confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 70.
LoginPageFooterHTMLNo  
Specify the HTML content to be displayed as the footer.
LogoImageNo  
Specify the logo image to be displayed.
LogoImage confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • File formats 'jpg', 'gif', 'bmp', 'png', 'jpeg', 'jpe', 'jfif', 'dib', 'tif', 'tiff', 'JPG', 'GIF', 'BMP', 'PNG', 'JPEG', 'JPE', 'JFIF', 'DIB', 'TIF', 'TIFF' are allowed.
LogoNo Default 
Select 'Custom' if custom logo is to be uploaded. Select 'Default' to use the default logo.
Logo confines to:
  • Type is 'SCALAR'.
  • Only 'Custom', 'Default' are allowed.
LoginPageHeaderHTMLNo  
Specify the HTML content to be displayed as the header.
UsernameFieldLabelNo Username 
Specify the label for the 'Username' textbox.
UsernameFieldLabel confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 20.
PageTitleBackgroundColorNo 055BB5 
Specify hexadecimal color code to be used for the page title background.
PageTitleBackgroundColor confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 6.
UserPromptFontColorNo 055BB5 
Specify hexadecimal color code to be used for the user prompt.
UserPromptFontColor confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 6.
LogoLinkNo  
Specify URL to be used when clicking on the logo.
LogoLink confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • The URL should start with ftp/http/https or the IP Address should be an IPv4 Address.
UserPromptNo Sign in to access this network 
Specify the user prompt for the Captive Portal Page.
UserPrompt confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 64.
UseCustomLayoutNo Disable 
Select 'Enable' to use a custom HTML layout for the Captive Portal page. Select 'Disable' to use the default layout.
UseCustomLayout confines to:
  • Type is 'SCALAR'.
  • Only 'Disable', 'Enable' are allowed.
HeaderFooterFontColorNo  
Specify hexadecimal color code to be used for the header and footer text.
HeaderFooterFontColor confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 13.
LogoutButtonLabelNo Sign out 
Specify the label for the Logout button.
LogoutButtonLabel confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 20.
BackgroundColorNo FAFAFA 
Specify hexadecimal color code to be used for the background.
BackgroundColor confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 6.
LoginButtonLabelNo Login 
Specify the label for the Login button.
LoginButtonLabel confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 20.
UserPortalLinkLabelNo Access the User Portal 
Specify label to be displayed for user portal link.
UserPortalLinkLabel confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 50.
UserPortalLinkFontColorNo 1987CB 
Specify hexadecimal color code to be used for the user portal link label.
UserPortalLinkFontColor confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 6.
PasswordFieldLabelNo Password 
Specify the label for the 'Password' textbox.
PasswordFieldLabel confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 20.
UserDefinedTemplateNo  
Custom HTML text for the Captive Portal page when custom layout is selected.



Operation   Status   Message
Captive Portal Appearance200
Captive Portal Appearance500


© Copyright 2019 Sophos Firewall Limited. All rights reserved.
Sophos Firewall is registered trademarks of Sophos Firewall Limited and Sophos Firewall Group. All other product and company names mentioned are trademarks or registered trademarks of their respective owners.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise unless you are either a valid licensee where the documentation can be reproduced in accordance with the license terms or you otherwise have the prior permission in writing of the copyright owner.