Initial Install

Note that apps were called add-ons before Jira 8. So when we refer to apps, this is synonymous with add-ons in Jira 7.x. 

Prerequisites

• You need administration rights in your Jira, so you can install apps from the marketplace
• You need write access to the library folder of your Jira installation, so you can add jars to it 

Step 1: Install the S/Notify UI from the Atlassian marketplace

1. In Jira, select Manage apps from the Jira Administration menu in order to go to the Atlassian Marketplace for Jira 
2. Search for S/Notify Email Encryption
3. Click the Free trial button for a free evaluation (of course, you may click Buy now, if you have already evaluated it)
4. Follow the instructions

The S/Notify UI component will then be downloaded, installed, and activated. However, emails will not be encrypted until the library component has been installed as explained in step 2 and 3. 

Step 2: Download and install the S/Notify library component 

1. Download the S/Notify mailer library component from https://download.savignano.net/snotify/jira/releases/
   (previous versions can be found in the subfolder archive)
   
   • net.savignano.s-notify.jira.mailer-x.x.x.jar
2. Copy the jar file to <YourJiraInstallationDirectory>/atlassian-jira/WEB-INF/lib 

Make sure that the the library component is readable by the Jira user. 

Step 3: Restart Jira to activate S/Notify

It is necessary to restart Jira after the installation in order to activate the library component.

Atlassian: How to start and stop Jira applications

Step 4: Verify the installation

1. In Jira, select Manage apps from the Jira Administration menu
2. In the menu on the left, click Manage apps
3. Find S/Notify in the list, expand its entry, then click Get started
4. S/Notify will check if it is ready to encrypt emails and display an info about the result

How To Proceed

We recommend that you perform a Quick Test to verify that S/Notify is working correctly.

To configure S/Notify to suit your needs, go to

• Encryption Settings – to configure how and when encryption should be used
• User Key Management – to manage your users' public PGP keys and S/MIME certificates required to encrypt outgoing emails
• Server Key Management – to manage the server's private PGP keys and S/MIME certificates required to decrypt incoming emails and sign outgoing emails

You might want to invite your Jira users to take a look at 

• User Settings – for users to view and optionally upload their own PGP key or S/MIME certificate
• Project Settings – for project administrators to view and optionally control encryption for emails referring to their projects

A Note On Encryption Strength

Note that older versions of the Java VM may not support strong encryption in your region out of the box. For details about which Java versions support only limited cryptography and how to change that, please refer to Java Cryptography Support.

How To Update

We recommend that you always verify the installation again after any updates by clicking Get started afterwards as explained in step 4 of the installation instructions.

Updating S/Notify

When updating S/Notify, remember that you must also update the mailer library. To perform a complete update:

1. Stop Jira
2. Remove the old mailer library
   sudo rm <YourJiraInstallationDirectory>/atlassian-jira/WEB-INF/lib/net.savignano.s-notify.*
3. Download and install the new mailer library (same way as for an initial install)
4. Start Jira
5. Update the UI component of S/Notify using Jira's standard mechanism from Manage apps in the Jira Administration menu

Updating Jira

Using the Standard Jira Installer

When you use the standard Jira installer to update your Jira instance to a newer version, note that the installer usually removes all third-party libraries in <YourJiraInstallationDirectory>/atlassian-jira/WEB-INF/lib. 

Therefore, after the update, check if the net.savignano.snotify.jira.mailer* jar has been removed. If so, please re-install it as described in Step 2: Download and install the S/Notify library component. 

Quick Test 

The easiest and quickest way to verify the installation is 

1. Log in with an administrative user who has an S/MIME public certificate or PGP public key available 
2. Navigate to the user profile
3. At section Email Security, click on the edit symbol
4. Upload an S/MIME public certificate or PGP public key that is valid for this user's email address
5. Navigate to Systems Settings > Outgoing Mail and click on Send a Test Email to quickly send an email to yourself
6. The email should immediately be sent to you encrypted

To test a notification email generated by Jira

1. Prepare as described above, except that you do not need an administrative user
2. To simplify testing, in the Preferences section of the user profile, set My Changes to Notify me
3. Create a Jira task
4. Modify the Jira task
5. A notification email about the modification should be sent to you after a while, and it should be encrypted

If the tests do not work, we recommend that you check out the FAQ for possible solutions – or open a ticket at our help desk.

Related articles

• Page:
  Space Settings - S/Notify for Confluence
• Page:
  Encryption Settings - S/Notify for Confluence
• Page:
  Server Key Management - S/Notify for Jira
• Page:
  User Key Management - S/Notify for Jira