==================
Setting Up Clients
==================


Background
==========

A **Client** is the place to put settings that relate to a single
website.

Basic Settings
==============

   :name: The name appears in invitations and on the initial password
     settings page.
   :site: The url that this client uses, requires OPS setup.
   :alternate site: Not used
   :theme: Affects the appearance of the login and home pages.
   :admin users: People who can invite users to this client and perform ETL.
     Every client should have at least one admin user and their password
     should be a secret.

.. image:: images/Change_client___Juicebox_Admin__v3_2_0_Basic.png

Client Invitations
==================

   :Default from email: The email address that invitations will come from. These
      require OPS setup as they must have an validation email sent and clicked
      on by the client to be usable.
   :Invitation subject: The subject line for people who get invited to this
      client.
   :Invitation body: The body of the email when you invite new users to this
     client.

.. image:: images/Change_client___Juicebox_Admin__v3_2_0_Invitations.png

Signing In
==========

   :Login title: These appear on the login page.
   :Login subtitle:

.. image:: images/Change_client___Juicebox_Admin__v3_2_0_Logging_In.png

Error pages and Support
=======================

The majority of this page contains messages that appear when various error
conditions are hit.

   :Support email: Not currently used.


.. image:: images/Change_client___Juicebox_Admin__v3_2_0_Error.png

Security
========

Settings that affect users passwords are self-explanatory.

   :Session duration: The user will automatically be logged out after this
       amount of time in seconds. They will get a popup message asking if they
       want to continue to stay logged in with either a half hour remaining or
       if half the time has elapsed.
   :Use fullstory: Fullstory is a user tracking tool that we use to check
       user behavior. Turn on to enable tracking if data is not HIPAA data.

.. image:: images/Change_client___Juicebox_Admin__v3_2_0_Security.png

SSO Settings
============

.. warning:: The server must be restarted for any changes in SSO Settings to
  take effect.

Clients can define a SSO Settings object that allows single signon. This
is currently very simple. The important settings are:

    :Sso type: This is not an important setting. Sorry to start this
     parameter block on such a bad note. All the other
     settings are important but this one is not currently used.
    :Sso path: The path that the login view will be served at.
    :Login view: The name of the django view in people.sso_view that you want
     to use to log the user in.
    :Login url: A url to redirect to if the user is not logged in. This will
     typically redirect back to ``sso_path``.
    :Logout url: A url to redirect to when the user logs out.
    :Create unknown user: The ``login_view`` can use this to decide whether
     to just log in users that already exist or to create new ones.

.. image:: images/Change_SSO_Settings___Juicebox_Admin__v3_3_2_.png

See ``people.views.simple_sso_view`` for details on how to set up a Single
Signon Django view.