.. Reminder for header structure:
  Parts (H1)          : #################### with overline
  Chapters (H2)       : ******************** with overline
  Sections (H3)       : ====================
  Subsections (H4)    : --------------------
  Subsubsections (H5) : ^^^^^^^^^^^^^^^^^^^^
  Paragraphs (H6)     : """""""""""""""""""""

.. meta::
 :description: Quickstart - Installing the WAPT Console
 :keywords: Quickstart,WAPT,Console,Install

.. _quickstart_install_wapt_console:

########################################
Quickstart - Installing the WAPT Console
########################################

The WAPT Server having been successfully installed, now we will install the WAPT Console.

* Managing WAPT is done mainly via the WAPT Console installed on the :term:`Administrator`'s workstation.

* It is recommended that the Administrator's computer be joined to the :term:`Organization`'s Active Directory.

* The host name of the Administrator's workstation **MUST NOT be longer than 15 characters**.
  This is a limit of *sAMAccountName* attribute in Active Directory.

* **The Administrator's computer will become critical for WAPT administration and WAPT package testing**.

.. warning::

  The WAPT Console **MUST NOT** be installed on the WAPT Server.

  The WAPT Console **MUST** be installed on the workstation from which you manage your network.

To download the :file:`waptsetup.exe` file, point your web browser to your waptserver url https://srvwapt.mydomain.lan, then click on the :guilabel:`WAPTSetup` link on the right-hand side of the WAPT Server web page.
The WAPT Server home page only provides basic server status information and the download link for the WAPT Console. 

.. figure:: wapt-resources/wapt_server_web-interface_browser-window.png
  :scale: 75%
  :align: center
  :alt: The WAPT Server interface in a web browser

  The WAPT Server interface in a web browser

*********************************************************
Installing the WAPT Setup on the Administrator's computer
*********************************************************

* Start the executable installer as :term:`Local Administrator` on the :term:`Administrator`'s workstation.

* Choose the language for the WAPT installer and click on :guilabel:`OK` to go on to the next step.

* Accept the licence terms and click on :guilabel:`Next` to go to next step.

* Click on :guilabel:`Next` to keep the default WAPT installation folder.

* Click on :guilabel:`Next` with just :guilabel:`Install WAPT service` checked.

* Set up the WAPT Server URL.
  The WAPT Server URL can be an IP address, although a :abbr:`FQDN (Fully Qualified Domain Name)` is recommended.
  Leave the check options as they are.

* Check :guilabel:`Static WAPT Informations` and set:

    * WAPT repository URL: http://srvwapt.mydomain.lan/wapt.

    * WAPT Server URL: https://srvwapt.mydomain.lan.

.. figure:: wapt-resources/wapt_install_waptsetup.gif
  :align: center
  :alt: install waptsetup.exe

  install of file waptsetup.exe

* Choose the WAPT repository and the WAPT Server; click :guilabel:`Next`.

* Get a summary of the WAPT Console installation and click :guilabel:`Install` to launch the installation, wait for the installation to complete, then click on :guilabel:`Finish` (leave default options).

Starting the WAPT Console
=========================

* Launch the WAPT Console:

  * By looking for the binary.

    :file:`C:\\Program Files (x86)\\wapt\\waptconsole.exe`

  * Or using the :guilabel:`Start` Menu.

* Log into the WAPT Console with the **AD Account** login and password or **local Admin** on waptserver. (if you use "auto" mode)

  .. figure:: wapt-resources/quickstart_wapt_console_user-authentication_dialog-box.png
    :align: center
    :alt: The WAPT Console authentication window

    The WAPT Console authentication window

On first start, you **MUST** start the WAPT Console with elevated privileges.
:menuselection:`Right-click on the WAPT Console binary --> Start as Local Administrator`.

.. note::

  The recommended screen resolution for using the WAPT Console is 1920x1080 and the minimum screen resolution is 1280x1024.

.. _quickstart_create_certificate:

********************************************************************
Generating the Administrator's certificate for signing WAPT packages
********************************************************************

* A message will appear indicating that no personal certificate has been defined.

  .. figure:: wapt-resources/wapt_console_no-certificate_dialog-box.png
    :align: center
    :alt: WAPT personal certificate not found in the WAPT Console

    WAPT personal certificate not found in the WAPT Console

* Select :guilabel:`Yes`

.. figure:: wapt-resources/wapt_console_basic-configuration-tab_container-window.png
  :scale: 75%
  :align: center
  :alt: Window for the basic configuration of the WAPT Console

  Window for the basic configuration of the WAPT Console

* Click on :guilabel:`New private key and certicate` to :ref:`create your certificate <quickstart_create_certificate>`.

* In the example, the name of the public certificate signed with the private key is :file:`wapt-private.crt`.
  This certificate is used to validate the signature of packages before installation.
  If the public certificate used on the WAPT Console is not derived from the private key used for generating the WAPT Agents, the WAPT Console will not see the WAPT Agents and you will not be able to perform any action on any WAPT Agent.

* In the example, the name of the private key is :file:`wapt-private.pem`.
  It is located by default in the :file:`C:\\private` folder of the :term:`Administrator` workstation and is password protected.
  It will be used along with the certificate to sign packages before uploading them onto the WAPT repository.
  
  .. danger::

    The :file:`wapt-private.pem` file is **fundamental for security**.
    It **MUST** be stored in a safe place and correctly protected.
    The :file:`wapt-private.pem` file **MUST NOT** be stored on the WAPT Server.

* Fill the informations to create a self-signed certificate.

.. figure:: wapt-resources/wapt_console_certificate-generate_dialog-box.png
  :align: center
  :alt: Creating a self-signed certificate for the WAPT Enterprise version

* Click on :guilabel:`OK` to go on to the next step.

* Click on :guilabel:`Yes` to copy the newly generated certificate in the folder :file:`C:\\Program Files (x86)\\wapt\\ssl` on Windows or :file:`/opt/wapt/ssl` on Linux or macOS.
  This certificate will be picked up during the compilation of the WAPT Agent and deployed on the client computers.
  
  .. figure:: wapt-resources/wapt_console_certificate-confirm-copy-into-ssl-folder_dialog-box.png
    :align: center
    :alt: Dialog box requesting confirmation of the copy of the certificate in the ssl folder in the WAPT Console

    Dialog box requesting confirmation of the copy of the certificate in the ssl folder in the WAPT Console

************************
Packet prefix definition
************************

* A message will appear indicating that no package prefix has been defined.

.. figure:: wapt-resources/wapt_console_no-prefix_dialog-box.png
  :align: center
  :alt: Dialog box informing that no prefix has been set in the WAPT configuration

  Dialog box informing that no prefix has been set in the WAPT configuration

* Select :guilabel:`Yes`.

* Set your packages prefix on :guilabel:`WAPT packages prefix`.

.. figure:: wapt-resources/wapt_console_basic-configuration-tab_container-window-completed.png
  :scale: 75%
  :align: center
  :alt: Window for the basic configuration of the WAPT Console

  Window for the basic configuration of the WAPT Console

*************************
Activating a WAPT licence
*************************

* A message will appear indicating that no licence has been found, click on yes to activate a licence.
  To activate the licence, use the :file:`licence.lic` file provided by our sales department.

.. figure:: wapt-resources/quickstart-activate-licence.gif
  :scale: 75%
  :align: center
  :alt: Window listing no subscribed WAPT licences in the WAPT Console

  Window listing no subscribed WAPT licences in the WAPT Console

.. _quickstart_create_WAPT_agent:

***********************
Creating the WAPT Agent 
***********************

.. note::

  A message may appear indicating that your WAPT Agent version is obsolete or not yet present.

If the :ref:`Administrator's certicate <quickstart_create_certificate>` already exists, you can now :ref:`generate the new WAPT Agent <quickstart_create_WAPT_agent>` by clicking on :guilabel:`Yes`.

If no Administrator's certificate exists, click on :guilabel:`No` to generate the :ref:`Administrator's certicate <quickstart_create_certificate>`.

.. figure:: wapt-resources/wapt_console_waptagent-build_menu-item.png
  :align: center
  :alt: Generating the WAPT Agent from the WAPT Console

  Generating the WAPT Agent from the WAPT Console

* Fill in the informations that are necessary for the installer.

.. figure:: wapt-resources/quickstart_wapt_console_waptagent-configuration_container-window.png
  :scale: 75%
  :align: center
  :alt: Filling in the informations on your Organization

  Filling in the informations on your Organization

* Provide the password for unlocking the private key.

.. figure:: wapt-resources/wapt_console_enter-certificate-password_dialog-box.png
  :align: center
  :alt: Providing the password for unlocking the private key

  Providing the password for unlocking the private key

Once the WAPT Agent installer has finished building, a confirmation dialog pops up indicating that the :program:`waptagent` binary has been successfully uploaded to https://srvwapt.mydomain.lan/wapt/.