Annotation of loncom/html/adm/help/tex/Domain_Configuration_Login_Page.tex, revision 1.9

1.1       raeburn     1: \label{Domain_Configuration_Login_Page}
1.4       raeburn     2: If your domain has more than one server you have the option to configure whether 
1.7       raeburn     3: any of the servers will redirect to another server whenever the log-in page is requested.  This can be useful if you maintain a portal or ``Load Balancer'' server which 
1.4       raeburn     4: forms your institution's gateway to LON-CAPA. You can specify the path to which 
                      5: the user should be redirected, and also whether log-in page requests from specific
                      6: IP addresses should be exempt from the redirection.  The exemption is useful 
                      7: if you run a monitoring script which tests log-in, course display, and logout periodically for each of your LON-CAPA servers.
                      8: 
                      9: If your domain only has one LON-CAPA server, or you have multiple servers and will 
                     10: display their log-in pages, their appearance can be customized as follows:
1.1       raeburn    11: 
                     12: \begin{itemize}
1.2       raeburn    13: \item uploading custom image files 
1.1       raeburn    14: \item changing colors of text, links or backgrounds 
1.2       raeburn    15: \item enabling/disabling display of specific links 
1.1       raeburn    16: \end{itemize}
                     17: Logos displayed in the login page configuration table are scaled down
                     18: from the full size used in the login-page itself. 
                     19: 
                     20: 
                     21: 
                     22: \hfill{}
                     23: 
                     24: \noindent The following elements are configurable: 
                     25: 
                     26: \begin{itemize}
                     27: \item Header image at the top of the page
1.2       raeburn    28: \item Main Logo centered in the upper part of the main panel 
1.1       raeburn    29: \item Domain logo in the lower left corner of the main panel 
1.8       raeburn    30: \item Header above the login panel - can also be set to use text ``Login''
                     31: instead of an image. 
1.2       raeburn    32: \item Background colors for the page itself, the main panel, and the left
1.1       raeburn    33: (side) panel. 
                     34: \item Text color used for text on the page
1.5       raeburn    35: \item Text colors used for active, visited and unvisited links
1.9     ! raeburn    36: \item Enable/disable display of four links: 
1.1       raeburn    37: 
                     38: \begin{itemize}
1.3       bisitz     39: \item Course/Community Catalog, for a catalog of courses and communities
1.2       raeburn    40: \item Admin E-mail, for the e-mail address of the administrator 
1.5       raeburn    41: \item Contact Helpdesk, to display a web form used to submit a help request 
1.2       raeburn    42: \item New User, for users to create their own accounts 
1.1       raeburn    43: \end{itemize}
                     44: \item Default colors for links in the page, depending on status: either
                     45: active, visited or default (if neither apply).
                     46: \end{itemize}
1.5       raeburn    47: 
                     48: \hfill{}
                     49: 
1.9     ! raeburn    50: A ``Log-in Help'' link will be displayed immediately above any of the four optional links:
        !            51: Catalog, Contact Helpdesk, Admin Email, and New User.  Configuration options determine to which
1.5       raeburn    52: file(s) the ``Log-in Help'' points. The default file can be replaced with a custom HTML file
                     53: containing information pertinent to your institution.  In addition, versions of the custom
                     54: file, translated into the twelve languages supported by LON-CAPA can be uploaded, and the
                     55: link will automatically point to the appropriate (localized) file, depending on the viewer's 
                     56: language preference (as reported by the client web browser).
                     57: 
                     58: \hfill{}
                     59: 
                     60: Where the ``Contact Helpdesk'' web form is in use it can be configured to include a CAPTCHA
                     61: mechanism to discourage robotic form completion.  There are two types of CAPTCHA to choose
                     62: from -- the ``original'' CAPTCHA which uses a self-contained perl module included with the
1.6       raeburn    63: LONCAPA prerequisites, or ReCAPTCHA, which uses an external web service --
1.5       raeburn    64: https://google.com/recaptcha -- and requires you to create an account and generate public
                     65: and private keys which will be entered in the domain configuration form.  If you have more
                     66: than one server in your domain, you should request ``global'' keys, as the same keys will be
1.9     ! raeburn    67: used by the Contact Helpdesk ReCAPTCHA on all servers in your domain. If using ReCAPTCHA, you
        !            68: can indicate whether version 1 or 2 should be used.
1.7       raeburn    69: 
                     70: \hfill{}
                     71: 
                     72: The head portion of the log-in page may contain custom mark up (e.g., a script block containing
                     73: javascript for page analytics) in a file which will be uploaded and published public.
                     74: Different custom markup may be uploaded for each server in a domain, and a comma separated list
                     75: of IP addresses may be specified for which the custom markup will not not be included in the page, 
                     76: when the request for the log-in page originates from one of those addresses. A use case for the
                     77: exempt IP addresses is where robotic requests for the log-in page and made from a monitoring
                     78: machine, used to detect when a LON-CAPA server is not working correctly. 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>