Administration du support des applications Jira

Définissez ou modifiez le serveur de messagerie SMTP

  1. Choisissez Administration () > Système.
  2. Sélectionnez Courrier > Courrier sortant pour ouvrir la page du serveur de messagerie SMTP.
     (info) Si aucun serveur de messagerie SMTP n’a été défini, un bouton Configurer un nouveau serveur de messagerie SMTP s’affiche sur la page. Si l’un d’eux a déjà été défini, les détails du serveur de messagerie SMTP seront affichés sur la page, ainsi qu’un ensemble de liens d’opération à droite.
  3. Cliquez soit sur le bouton Configurer un nouveau serveur de messagerie SMTP pour définir un nouveau serveur de messagerie SMTP, soit sur le lien Modifier à droite pour modifier le serveur de messagerie SMTP existant, ce qui ouvrira la page Ajouter/mettre à jour le serveur de messagerie SMTP.

  4. Remplissez la section supérieure de cette page comme suit:

    Nom

    Spécifiez un nom arbitraire pour identifier cette configuration de serveur de messagerie SMTP.

    Description

    ( Facultatif) Spécifiez une description arbitraire qui décrit le serveur de messagerie SMTP. Cette description apparaît sous le nom du serveur de messagerie SMTP sur la page de configuration du serveur de messagerie SMTP.

    De l’adresse

    Spécifiez l’adresse e-mail utilisée dans le champ  » adresse de l’expéditeur  » (ou  » de « ) des messages de notification envoyés par Jira, sauf si elle est remplacée dans une configuration de projet.
     (info) Spécifiez uniquement une adresse e-mail pour ce champ (par exemple [email protected]). Jira utilisera cette valeur pour construire l’en-tête complet ‘from’ en fonction de l’utilisateur actuel ("Joe Bloggs (Jira) <[email protected]>").
    Pour modifier l’en-tête ‘from’, allez dans Administration > Configuration générale du système > et (sous Paramètres), modifiez le champ Email from.

    Préfixe de courriel

    Spécifiez l’objet des e-mails envoyés depuis ce serveur utilisera cette chaîne comme préfixe. Ceci est utile pour vos utilisateurs afin qu’ils puissent filtrer les notifications par e-mail de Jira en fonction de ce préfixe.

    Capture d’écran: Ajouter (ou mettre à jour) un serveur de messagerie SMTP

     Ajouter une page de serveur de messagerie SMTP.

Spécifiez un nom d’hôte ou un emplacement JNDI pour votre serveur de messagerie SMTP

La deuxième partie de la page Ajouter/mettre à jour le serveur de messagerie SMTP spécifie les détails du serveur de messagerie SMTP auquel Jira enverra du courrier. Il y a deux façons de le faire. Soit:

  • spécifiez les détails de l’hôte SMTP de votre serveur de messagerie SMTP ;
    ou:
  • spécifiez l’emplacement JNDI d’un objet javax.mail.Session, c’est-à-dire utilisez JNDI pour rechercher un serveur de messagerie SMTP que vous avez préconfiguré dans votre serveur d’applications. Cela présente les avantages suivants:
    • Meilleure sécurité: les détails du courrier ne sont pas disponibles pour les administrateurs Jira via l’interface d’administration Jira et ne sont pas stockés dans des fichiers de sauvegarde Jira.
    • Plus d’options SMTP : par exemple, vous pouvez passer à RSET au lieu de NOOP pour tester les connexions en définissant la propriété mail.smtp.userset.
    • Gestion centralisée: les détails du courrier sont configurés au même endroit que les détails de la base de données et peuvent être configurés via les outils d’administration de votre serveur d’applications.

Spécifiez les détails de l’hôte SMTP

La plupart des gens configurent le serveur de messagerie SMTP de Jira en spécifiant les détails de l’hôte SMTP de ce serveur de messagerie directement dans Jira.

  1. Dans la section Hôte SMTP de la page Ajouter/mettre à jour le serveur de messagerie SMTP (ci-dessus), remplissez les champs de formulaire suivants:

    Fournisseur de services
    (non disponible lors de la mise à jour d’un serveur de messagerie SMTP existant)

    Choisissez entre utiliser votre propre serveur de messagerie SMTP (c’est-à-dire personnalisé), ou Gmail (c’est-à-dire Google Apps Mail / Gmail) ou Yahoo! (c’est-à-dire Yahoo! Mail Plus) en tant que fournisseur de services pour votre serveur de messagerie SMTP.
     (info) Si vous choisissez Gmail ou Yahoo! options, puis revenez à Personnalisé, certains des champs clés de cette section seront automatiquement remplis avec les paramètres du serveur de messagerie SMTP pertinents pour ces fournisseurs de services.

    Protocole

    Choisissez si votre serveur de messagerie SMTP est standard (c’est-à-dire SMTP) ou sécurisé (c’est-à-dire SECURE_SMTP).

    Nom d’Hôte

    Spécifiez le nom d’hôte ou l’adresse IP de votre serveur de messagerie SMTP. Par exemple. smtp.yourcompany.com

    Port SMTP

    ( Facultatif) Le numéro de port SMTP, généralement 25 pour SMTP ou 465 pour SMTP, dont l’un ou l’autre est supposé si ce champ est laissé vide.

    Délai d’attente

    ( Facultatif) Spécifiez le délai d’expiration en millisecondes, qui est traité comme 10000 si ce champ est laissé vide. En spécifiant 0 ou une valeur négative ici, Jira attendra indéfiniment la réponse du serveur SMTP.

    TLS

    ( Facultatif) Cochez cette case si votre hôte SMTP utilise le protocole TLS (Transport Layer Security).

    Nom d’utilisateur

    ( Facultatif) Si votre hôte SMTP nécessite une authentification, spécifiez le nom d’utilisateur de ces informations d’authentification ici. (La plupart des serveurs de l’entreprise nécessitent une authentification pour relayer le courrier aux utilisateurs non locaux.)

    Mot de Passe

    ( Facultatif) Encore une fois, si votre hôte SMTP nécessite une authentification, spécifiez le mot de passe associé au nom d’utilisateur que vous avez spécifié ci-dessus.
     (info) Lors de la modification d’un serveur de messagerie SMTP existant, cochez la case Modifier le mot de passe pour accéder et modifier ce champ.

    ( attention) Veuillez noter:

    • Si le script de démarrage de votre serveur utilise les propriétés système -Dmail (par exemple mail.smtp.host ou mail.smtp.port), elles remplaceront les paramètres que vous spécifiez dans le formulaire ci-dessus. De plus, si nécessaire, vous pouvez spécifier manuellement le nom d’hôte que Jira signale lui-même au serveur SMTP en définissant -Dmail.smtp.localhost

    • Le SMTP doit prendre en charge le type de contenu en plusieurs parties. Sans cela, les mails ne pourront pas être envoyés.
  2. ( Facultatif) Cliquez sur le bouton Tester la connexion pour vérifier que Jira peut communiquer avec le serveur de messagerie SMTP que vous venez de configurer.
  3. Cliquez sur le bouton Ajouter (ou Mettre à jour) pour enregistrer la configuration du serveur de messagerie SMTP de Jira.

Spécifiez un ‘Emplacement JNDI’

Comme alternative à la spécification des détails de l’hôte SMTP directement dans Jira, vous pouvez les configurer dans votre serveur d’applications, puis rechercher une session de messagerie préconfigurée via JNDI.

Dans la section Emplacement JNDI de la page Ajouter/mettre à jour le serveur de messagerie SMTP (ci-dessus), spécifiez l’emplacement d’un objet javax.mail.Session à utiliser lors de l’envoi d’e-mails, dans le champ Emplacement JNDI. Cela commencera par le préfixe java:comp/env/

Configuration d’un emplacement JNDI

L’emplacement JNDI que vous spécifiez dans Jira dépendra du serveur d’applications et de la configuration de Jira. Les emplacements JNDI sont généralement configurés dans le serveur d’applications qui exécute Jira. Par conséquent, Jira devra être redémarré après avoir configuré un emplacement JNDI pour que cette configuration soit disponible dans Jira.

Par exemple, dans Tomcat 6 (le serveur d’applications fourni avec les distributions  » recommandées  » de Jira), votre emplacement JNDI serait java:comp/env/mail/JiraMailServer et vous ajouteriez la section suivante au conf/server.xml du répertoire d’installation de votre application Jira, à l’intérieur du nœud <Context/>:

<Context path="" docBase="${catalina.home}/atlassian-jira" reloadable="false"> ... <Resource name="mail/JiraMailServer" auth="Container" type="javax.mail.Session" mail.smtp.host="mail.yourcompany.com" mail.smtp.port="25" mail.transport.protocol="smtp" mail.smtp.auth="true" mail.smtp.user="jirauser" password="mypassword" /> ...</Context>

Ou si vous n’avez pas besoin d’authentification (par exemple, si vous envoyez via localhost, ou uniquement en interne au sein de l’entreprise):

<Context path="" docBase="${catalina.home}/atlassian-jira" reloadable="false"> ... <Resource name="mail/JiraMailServer" auth="Container" type="javax.mail.Session" mail.smtp.host="localhost" mail.smtp.port="25" mail.transport.protocol="smtp" /> ...</Context>

Si vous exécutez Jira sur un serveur d’applications autre qu’Apache Tomcat (qui n’est pas une configuration Jira prise en charge), une méthodologie similaire pour configurer un emplacement JNDI sur votre serveur de messagerie SMTP doit s’appliquer à ce serveur d’applications.

Si vous rencontrez des problèmes de connexion, ajoutez un paramètre mail.debug="true" à l’élément <Resource/> (ci-dessus), qui vous permettra de voir les détails de « débogage » au niveau SMTP lors du test de la connexion.

Déplacer les classes JavaMail

Vous devrez également vous assurer que les classes JavaMail (généralement dans les fichiers de bibliothèque JAR) sont présentes dans le chemin de classe de votre serveur d’applications et qu’elles n’entrent pas en conflit avec les fichiers de bibliothèque JAR de Jira. Cela est nécessaire car le serveur d’applications lui-même (et non Jira) établit la connexion SMTP et, en tant que tel, le serveur d’applications ne peut pas voir les fichiers de la bibliothèque JAR dans le chargeur de classes de Jira.

Certains systèmes d’exploitation peuvent regrouper les classes JavaMail avec des serveurs d’applications (par exemple Tomcat dans Red Hat Enterprise Linux). Cela peut entrer en conflit avec la copie de Jira des classes JavaMail, entraînant des erreurs telles que:

java.lang.NoClassDefFoundError: javax/mail/Authenticator

ou:

java.lang.IllegalArgumentException: Mail server at location is not of required type javax.mail.Session.

Les serveurs d’applications plus légers tels qu’Apache Tomcat (y compris celui incorporé dans les distributions « recommandées » de Jira) ne sont pas toujours livrés avec JavaMail.

Pour éviter tout conflit, vérifiez le répertoire lib/ de votre serveur d’applications:

  • Si le serveur d’applications contient déjà mail-1.4.1.jar et activation-1.1.1.jar, supprimez simplement mail-1.4.1.jar et activation-1.1.1.jar du sous-répertoire <jira-application-dir>/WEB-INF/lib/ du répertoire d’installation de l’application Jira.
  • Si le serveur d’applications ne contient pas mail-1.4.1.jar et activation-1.1.1.jar, déplacez les mail-1.4.1.jar et activation-1.1.1.jar du sous-répertoire <jira-application-dir>/WEB-INF/lib/ du répertoire d’installation de l’application Jira vers le sous-répertoire lib/ du répertoire d’installation de Jira (pour les distributions  » recommandées  » de Jira) ou le sous-répertoire lib/ du serveur d’applications exécutant Jira.

SMTP sur SSL

Vous pouvez chiffrer les communications par courrier électronique entre Jira et votre serveur de messagerie via SSL, à condition que votre serveur de messagerie prenne en charge SSL.

Tout d’abord, vous devrez importer le certificat du serveur SMTP dans un magasin de clés Java. Le processus est décrit sur la page Configuration d’une connexion SSL à Active Directory.

( attention) Remarque importante : Sans importer le certificat, Jira ne pourra pas communiquer avec votre serveur de messagerie.

Deuxièmement, modifiez les propriétés de connexion de votre serveur de messagerie et spécifiez starttls et SSLSocketFactory. À partir de {$Jira_INSTALL}/conf/server.xml (cet exemple utilise le serveur de Gmail):

<Resource name="mail/GmailSmtpServer" auth="Container" type="javax.mail.Session" mail.smtp.host="smtp.gmail.com" mail.smtp.port="465" mail.smtp.auth="true" mail.smtp.user="[email protected]" password="mypassword" mail.smtp.starttls.enable="true" mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"/>

Dépannage

Une astuce utile pour déboguer les problèmes liés au courrier dans Jira consiste à définir la propriété -Dmail.debug=true au démarrage. Cela entraînera la journalisation des détails au niveau du protocole des interactions par e-mail de Jira. De plus, l’augmentation du niveau de journal de JIRA indiquera quand le service est en cours d’exécution et comment les courriers sont traités.

Problèmes courants

  • Si Jira ne semble pas créer ou envoyer d’e-mails ou créer des problèmes et des commentaires à partir d’e-mails, votre installation Jira pourrait rencontrer des erreurs OutOfMemory. Veuillez vérifier vos fichiers journaux pour les erreurs OutOfMemory. S’il y a des erreurs OutOfMemory, veuillez redémarrer Jira et enquêter sur les erreurs.
  • Si vous trouvez que certains e-mails entrants disparaissent tout simplement, vérifiez que vous n’avez pas accidentellement démarré une deuxième copie de Jira (par exemple. dans un environnement intermédiaire) qui télécharge et supprime des messages électroniques. Consultez la page Restauration des données pour connaître les indicateurs que vous devez définir pour empêcher le traitement du courrier.
  • Si vous recevez des erreurs de « Relais de messagerie », assurez-vous d’avoir spécifié le nom d’utilisateur et le mot de passe dans la section Hôte SMTP de la page de configuration du serveur de messagerie SMTP de Jira.

Obtenir de l’aide

Si vous ne pouvez pas résoudre un problème vous-même, veuillez créer un cas d’assistance dans le projet ‘Jira’ et nous vous aiderons.

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée.