.. _users: ======= Users ======= Accessing the Site ================== How to Login ------------ .. include:: _fragments/login.rst What to Do if You Can't Access the Site --------------------------------------- If you can't access the site either because you can't login (e.g. you forgot your username or password), or because your User profile doesn't have the right permissions to access restricted parts of the site, then you dhould contact the |sysadmin| by email to have the issue addressed. Securing the Site ================= Why Does the Site Need to be Secured ------------------------------------ The *Training Portal* contains a **lot** of potentially sensitive data including: - Staff training records - Company documents, approvals and training materials - Examinations and technical questions In order to protect this information, it's necessary to restrict access to the site only to appropriately authorised staff and candidates. How the Site Secured -------------------- User Login ~~~~~~~~~~ The *Training Portal* requires all users to *login* to the site using a username and password. .. figure:: ./_images/users-login.png :width: 400px *Training Portal* login screen This username and password is **separate** to the username and password used to access other parts of the Airnorth network in order to ensure that any security problems can't escalate to affect the *Training Portal*. A User's password can be reset either by the user (see :ref:`change-password`) or by system admin staff (see :ref:`admin-change-password`). User and Group Permissions ~~~~~~~~~~~~~~~~~~~~~~~~~~ The parts of the site a User can access is controlled by the *Groups* that a User belongs to. The following groups are available: - pilots - cabin_attendants - admins - tc_staff - ground_trainers - check_captains - training_coordinators - ftm - sysadmins The Group a User belongs to can be changed and updated by editing the Users profile (see :ref:`edit-user-profile`). .. _user-management: User Management =============== What is a User Profile ---------------------- A User profile stores information about the users of the *Training Portal*. This information includes the persons: #. Username #. Password #. Email address #. Full name and initials #. ARN (where applicable) #. Fleet assignment #. Rank (where applicable) #. Whether or not they receive email alerts #. Whether or not they are active and/or can login to the site Who can Add or Edit a User -------------------------- Users and their associated user profiles can be created and edit by Users who are in the ``sysadmins``, ``admins``, ``training_coordinators``, or ``ftm`` groups. .. note:: To edit or change the groups a User belongs to, see the :ref:`users` section of this documentation. How to Add a User ----------------- To add a User: #. Open the *Add User* for by either: - Clicking on the **Add User** entry in the *Admin* menu, or - Going to the *User Index* page and click on the **Add User** button at the top-right of the screen #. Fill out the details for the user in the *Add User* form and then click submit. .. figure:: ./_images/users-add.png :width: 650px Add User Form .. _edit-user-profile: How to Edit a User ------------------ To edit a user profile: #. Open the *User Index* page by selecting this entry in the *Admin* menu #. Locate the User to be edited in the *User Index* #. Hover over the ``>>`` in the far right column, then clikc on the **Edit User** item in the menu that appears. This will open the *Edit User* form. #. Edit or change the details in the *Edit User* form and then click submit. After editing the user profile you will be redirected back to the *User Index* page. .. note:: A User and their associated user profile can also be edited through the *System Admin* pages. Editing the profile through these pages allows additional actions to be performed, such as resetting or changing a User's password. Editing a User's profile through the *System Admin* pages can only be done by a user who is a member of the ``sysadmin`` group. See the :ref:`system-admin` section for further details. .. _user-remove: How to Remove a User -------------------- When a User is removed they are **not** deleted from the system: instead, their profile is set to **inactive**. To remove a user from the system: #. Open the *User Index* page as described above and locate the User to be removed #. Hover over the ``>>`` in the far right column and click on the **Remove** item in the menu that appears. .. note:: Users *cannot* be deleted by a normal user. If a user **absolutely** *has to be deleted* then this can be done by a ``sysadmin`` user through the admin control panel. See the :ref:`system-admin` section for details. .. _change-password: How to Change a Password ------------------------ A User's password can be changed by that User through a **Reset Password** link on the login screen. .. note:: A User's password can also be reset by a ``sysadmin`` user through the *System Admin* pages. See the :ref:`admin-change-password` section of this user guide for details. .. figure:: ./_images/users-change-password.png :width: 400px Change password link To change their password: 1. Enters your email address on the *Change Password* screen (accessed through the link described above). 2. You will receive an email containing a link to a page to reset your password. Click on the link to access the *Reset Password* page. 3. Enter your new password on the *Reset Password* page and click *Submit* Your password will now be reset. To access the site, go back to the `Login `_ page, enter your username and new password, and click *Submit*. Groups and Permissions ====================== What Are Groups and Permissions Used For ---------------------------------------- Groups are used to control what parts of the site Users are able to access, as well as control what they are able to do on the site. These controls are implemented by assigning *permissions* to each Group. All Users who belong to a particular group also have the permissions of that group. .. note:: The exact detail of what these permissions allow a User to do is set in the code which runs the site and cannot be modified by the Users. How are Groups and Permissions Changed or Added ----------------------------------------------- Groups can be created and modified through the *System Admin* pages by a User who is a member of the `sysadmin` group. However, this is not how the site has been designed to function, and doing so **will** compromise the security of the site. Instead, the groups, and the specific permissions that are set for them, are designed to be centrally controlled by the |sysadmin|. In any case, no changes should be required to either the Groups or Permissions in order for the site to function correctly. How are Users Assigned to a Group --------------------------------- Users are assigned to groups through the *Edit User* page. See the :ref:`edit-user-profile` section for details. .. note:: The groups a user belongs to can also be edited by a `sysadmin` user through the *System Admin* pages. See the :ref:`system-admin` page for details.