Skip to main content

Guide d’installation de BriefCam

Installer et configurer NGINX

Last Updated: 7 minute read
Version2025r1
LangueFrançais

Cette section décrit les étapes à suivre pour utiliser NGINX.

Note

Pour travailler avec SSL et BriefCam, l’utilisation d’un équilibreur de charge est nécessaire. BriefCam recommande d’utiliser NGINX.

Recommandations

Il est recommandé d’installer l’équilibreur de charge sur une machine séparée.

Si vous travaillez dans un environnement virtualisé, l’équilibreur de charge doit se trouver sur une machine séparée.

Si vous travaillez dans un environnement non virtualisé (serveurs physiques), vous pouvez avoir l’équilibreur de charge sur la même machine que les services Web (bien que ce ne soit pas recommandé). Cependant, si vous installez l’équilibreur de charge sur la même machine que les services Web, IIS doit fonctionner sur un port différent (pas 80, puisque 80 est pour NGINX).

Important

Il est recommandé de ne pas apporter de modifications manuelles au fichier de configuration NGINX. Cependant, si vous apportez des modifications, assurez-vous que toutes les modifications sont conformes à la syntaxe NGINX valide et que tous les noms de points de terminaison sont utilisés exactement comme définis, y compris la distinction majuscules/minuscules.

Prérequis

  • Assurez-vous que les ports 80 et 443 ne sont pas utilisés par une autre application.

  • Si IIS est installé, veillez à l’arrêter ou à modifier son port par défaut.

Étapes

  1. Pour exécuter l’assistant d’installation de BriefCam NGINX, cliquez droit sur le fichier BriefCamNGINX_<Version number>.exe et sélectionnez Run as administrator (Exécuter en tant qu’administrateur).

    Si vous utilisez la dernière mise à jour de Windows et qu’une alerte Windows Defender apparaît, cliquez sur le lien Plus d’infos et cliquez sur Exécuter quand même.

    Windows protected your PC4.png
  2. Dans l’écran de bienvenue, cliquez sur Get Started (Démarrer).

    NGINX_welcome.png
  3. Acceptez les termes du contrat de licence BriefCam et cliquez sur Suivant.

    NGINX_license_2.png
  4. Lisez le contrat de licence et cliquez sur Suivant.

    NGINX_license_1.png
  5. Saisissez l’adresse IP ou le nom d’hôte (s’il existe une résolution DNS) pour chacun des services concernés ci-dessous, puis cliquez sur Suivant. Notez qu’une fois que vous avez saisi l’hôte Research, vous pouvez cliquer sur le bouton « Cliquer pour utiliser l’hôte RESEARCH pour tous les services » pour remplir tous les champs avec cette valeur.

    NGINX_services_configuration.png
  6. Décidez si vous souhaitez utiliser une communication sécurisée.

    NGINX_using_HTTPS.png
  7. Si vous cochez la case, entrez les chemins d’accès au certificat et à la clé privée.

    Note

    Vous devez créer ou utiliser un certificat auto-signé existant séparé en deux fichiers : .crt et .key.

  8. Si votre certificat SSL est protégé par un mot de passe, vous devez configurer NGINX pour qu’il lise une liste de mots de passe qui sont stockés dans un fichier séparé. Si la clé privée ne se trouve pas dans ce fichier, NGINX ne démarrera pas. Pour ce faire, procédez comme suit :

    1. Créez un nouveau fichier texte nommé ssl_passwords.txt et enregistrez-le dans un dossier distinct de celui où se trouve le certificat SSL.

    2. Configurez le fichier pour qu’il ne soit lisible que par l’utilisateur qui exécute NGINX.

    3. Saisissez le mot de passe du certificat dans la première ligne du fichier ssl_passwords.txt .

    4. Dans le fichier nginx config , ajoutez la ligne suivante au-dessus des lignes de certificat existantes :

      ssl_password_file /var/lib/nginx/ssl_passwords.txt;

    5. Distribuez ce fichier séparément du fichier de configuration.

  9. Cliquez sur Suivant.

    L’écran suivant s’affiche.

    NGINX_Database_fields.png
  10. Dans les champs Database Host et Database Port, entrez le nom et le port de la machine sur laquelle vous avez installé PostgreSQL.

  11. Dans les champs Application User et Application Password, entrez le nom d’utilisateur et le mot de passe que vous avez saisis lors de l’installation de PostgreSQL.

  12. Cliquez sur le bouton Test Database Connection (Tester la connexion à la base de données).

  13. Cliquez sur Suivant.

  14. Confirmez ou sélectionnez le lecteur sur lequel vous souhaitez installer NGINX et cliquez sur Install (Installer).

    NGINX_install_path.png
  15. Si vous avez plus d’un nom d’hôte de service Web, après avoir installé NGINX, ouvrez le fichier nginx.conf (situé par défaut à : C:/nginx/conf) et dans http la section, copiez et collez les lignes existantes et mettez à jour les nouvelles lignes avec les noms d’hôte supplémentaires.

  16. Sur tout hôte exécutant l’application (navigateur), assurez-vous que les domaines (ou le nom d’hôte) peuvent être résolus par le DNS. Si aucun DNS n’est disponible, vous pouvez modifier le fichier hosts et ajouter l’adresse IP de l’équilibreur de charge en utilisant la syntaxe suivante :

    10.x.x.x www.example.com example.com

    Par exemple : 10.0.0.143 www.example.com

  17. Ouvrez les trois fichiers web config .js suivants sur le serveur BriefCam (par défaut, ces trois fichiers sont au C:\Program Files\BriefCam\WebServices) :

    • \app\webConfig.js

    • \ProWebAdminClient\web.config.js

    • \ProWebClient\webConfig.js

      NGINX Webconfig files.png
  18. Dans chacun des trois fichiers web config .js, définissez les points de terminaison (endPointApi) pour qu’ils pointent vers l’équilibreur de charge. Dans l’exemple ci-dessous, il vous suffit de remplacer PRODUCT1 par l’adresse de l’équilibreur de charge. Assurez-vous que « http: » n’apparaît pas dans le chemin.

    Web config endpoint.png
  19. Ouvrez le QLIK QMC avec l’utilisateur qui a été utilisé pour installer le module RESEARCH (https://<hostname>/qmc).

  20. Parcourez les proxies virtuels et ajoutez deux nouveaux paramètres en utilisant le nom d’hôte de chacune des machines (par exemple, les noms d’hôte de la machine QLIK et de la machine NGINX, comme indiqué dans l’image ci-dessous) aux deux proxies :

    • Virtual Proxies->bc->advanced->Host white list

    • Virtual Proxies->Central Proxy (par défaut)->advanced->Host white list

      Host white list.png

      Note

      Sur certains systèmes, vous devrez peut-être ajouter le nom d’hôte, le FQDN et l’adresse IP de l’équilibreur de charge et de toutes les instances de services Web dans la liste blanche des proxies virtuels de QMC.

  21. Dans l'écran User directory connectors (Connecteurs du répertoire utilisateur), accédez à la chaîne de connexion visible et ajoutez le nom de domaine à la valeur server . Par exemple, dans l’image ci-dessous, Stress-DB était la valeur d’origine et maintenant elle est Stress-DB.briefcamdev.com.

    Qlik User directory connectors.png
  22. Ouvrez le BriefCam Administrator Console.

  23. Si vous avez choisi d’utiliser une connexion sécurisée (https), définissez le paramètre d’environnement DefaultSiteProtocol sur https.

  24. Vérifiez que les paramètres d’environnement suivants sont définis sur l’adresse IP ou le FQDN de NGINX et assurez-vous que les URL commencent par http:// ou https:// (si vous avez choisi d’utiliser une connexion sécurisée :

    • BaseVideoUrl

    • clientNotificationEndPoint

    • CommonPlatformAPI.ServiceURL

    • DB.LocalStorageAddress

    • LoadBalancerAddress - Ce paramètre doit être défini sur le nom d’hôte NGINX (FQDN)

    • ProWebApiAddress

    • ProWebClientAddress

    • QlikServer

    • Site.Url

    • StorageGatewayUrl

    • SSOEndpoint - Si vous souhaitez utiliser un client intégré, cette valeur doit être définie à : http[s]://<NGINX-host>:8030/MilestoneSSO/

  25. Si vous installez un moteur OX basé sur Linux, assurez-vous que la valeur du paramètre d’environnement OX6.EngineOutputGatewayGrpcPort correspond à ce que vous avez saisi dans la boîte de dialogue Processing (par défaut 49149) du programme d’installation.

  26. Si vous installez un moteur OX basé sur Linux, assurez-vous que la valeur du paramètre d’environnement OX6.VmsAdapterGrpcPort correspond à ce qui a été saisi dans la zone Agent VMS du programme d’installation (par défaut 49151).

    NGINX_ports_check.png
  27. Redémarrez les services BriefCam .

  28. Si vous avez choisi d’utiliser une connexion sécurisée (https), naviguez jusqu’à l’application et vérifiez qu’elle fonctionne avec des requêtes https. Par exemple :

    • https://www.example.com/app

    • https://www.example.com/admin

Service NGINX Windows

Le programme d’installation de BriefCam NGINX crée un BriefCam service NGINX Web Server dans l’écran Windows Services. Ce service est chargé de s’assurer que le processus NGINX est constamment en cours d’exécution et que l’équilibreur de charge est prêt à accepter les demandes. L’utilisateur qui exécute ce service est l’utilisateur Windows BriefCam .

NGINX Web Server.png

Configurations génériques

Pour tout autre type d’équilibreur de charge, tel qu’Amazon ELB, Google Cloud Platform Load Balancer, etc., vous devez configurer des règles de redirection basées sur l’URL. Les règles de redirection sont les suivantes :

1. Service Notification

Recherchez : /signalr

Redirigez vers : notification-server:7080

2. Video Streaming Gateway

Recherchez : /vsg

Utilisez une règle de réécriture pour supprimer des /vsg de l’URL

Redirigez vers : videostreaming-server:5010

3. Research (Qlik)

Recherchez : /bc/

Redirigez vers : www.example.com:8090

4. Services Web

Recherchez : /

Redirigez vers : briefcam-webserver

5. Passerelle de stockage (le cas échéant)

Recherchez : /StorageGateway

Redirigez vers : storage gateway server:5012

6. Passerelle BI Hub (pour multisite)

Recherchez : /hubbigateway

Redirigez vers le serveur où la passerelle BI Hub est en cours d’exécution, port 5007

7. Outbound API Gateway (pour les sites multiples)

Recherchez : /outboundapigateway

Redirigez vers le serveur où Outbound API Gateway est exécuté, port : 5005

8. API de plateforme commune

Recherchez : /commonplatformapi/

Redirigez vers le serveur où le service Common Platform API est exécuté, port 5014

9. Gestion des tâches

Recherchez : /taskmanagement

Redirigez vers le serveur où le service de gestion des tâches est en cours d’exécution, port 5013