diff --git a/README.md b/README.md index a5f6ac4..7f79494 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,26 @@ -# Great DANE Thunderbird Extension +% Great DANE for Thunderbird + +## About The Great DANE Thunderbird extension integrates the [Great DANE Engine](https://github.com/grierforensics/Great-DANE-Engine) with Mozilla Thunderbird. -Once configured to communicate with a running Great DANE Engine, the plugin will automatically retrieve S/MIME certificates for senders of incoming mail and recipients of outgoing messages. +**NOTE**: Access to a running Great DANE Engine is required to use Great DANE for Thunderbird. See the [Great DANE Engine Github page](https://github.com/grierforensics/Great-DANE-Engine) for more information. + +Once configured to communicate with a running Great DANE Engine, the extension will automatically retrieve S/MIME certificates for senders of incoming mail and recipients of outgoing messages. + +If S/MIME encryption is enabled in Thunderbird and DANE SMIMEA records exist for all recipients of an outgoing message, certificate retrieval and storage and message encryption will occur automatically and transparently. + +## Installing + +The easiest way to install Great DANE for Thunderbird is through the Add-ons Manager in Thunderbird. Open *Add-ons* in Thunderbird and search for "Great DANE". + +It is also available for download here: [Great DANE for Thunderbird](https://addons.mozilla.org/en-US/thunderbird/addon/great-dane-smime/). + +You can optionally package the Add-on yourself and copy it to to your Thunderbird Profile's `extensions/` directory. Simply run `package.sh`, then copy `greatdane.xpi` to one of the following locations: -If S/MIME encryption is enabled in Thunderbird by default and DANE SMIMEA records exist for all recipients of an outgoing message, certificate retrieval and storage and message encryption will occur transparently. +- Windows: `%APPDATA%\Thunderbird\Profiles\\extensions\` +- Linux: `~/.thunderbird//extensions/` +- OS X: `~/Library/Thunderbird/Profiles//extensions/` Configure the Great DANE Engine address by navigating to Add-ons -> Great DANE -> Options. diff --git a/chrome.manifest b/chrome.manifest index e70b664..f4f6672 100644 --- a/chrome.manifest +++ b/chrome.manifest @@ -1,4 +1,5 @@ content greatdane content/ +skin greatdane classic/1.0 skin/ resource greatdane modules/ overlay chrome://messenger/content/messenger.xul chrome://greatdane/content/main.xul overlay chrome://messenger/content/messengercompose/messengercompose.xul chrome://greatdane/content/compose.xul diff --git a/content/help.css b/content/help.css new file mode 100644 index 0000000..6b1d300 --- /dev/null +++ b/content/help.css @@ -0,0 +1,16 @@ +body { + margin: 3em; +} + +h1 { + border-bottom: 1px solid black; +} + +a { + color: #0000EE; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} diff --git a/content/help.html b/content/help.html new file mode 100644 index 0000000..e9cd882 --- /dev/null +++ b/content/help.html @@ -0,0 +1,36 @@ + + + + + + + Great DANE for Thunderbird + + + + + +
+

Great DANE for Thunderbird

+
+

About

+

The Great DANE Thunderbird extension integrates the Great DANE Engine with Mozilla Thunderbird.

+

NOTE: Access to a running Great DANE Engine is required to use Great DANE for Thunderbird. See the Great DANE Engine Github page for more information.

+

Once configured to communicate with a running Great DANE Engine, the extension will automatically retrieve S/MIME certificates for senders of incoming mail and recipients of outgoing messages.

+

If S/MIME encryption is enabled in Thunderbird and DANE SMIMEA records exist for all recipients of an outgoing message, certificate retrieval and storage and message encryption will occur automatically and transparently.

+

Installing

+

The easiest way to install Great DANE for Thunderbird is through the Add-ons Manager in Thunderbird. Open Add-ons in Thunderbird and search for “Great DANE”.

+

It is also available for download here: Great DANE for Thunderbird.

+

You can optionally package the Add-on yourself and copy it to to your Thunderbird Profile’s extensions/ directory. Simply run package.sh, then copy greatdane.xpi to one of the following locations:

+
    +
  • Windows: %APPDATA%\Thunderbird\Profiles\<Profile Name>\extensions\
    • +
  • Linux: ~/.thunderbird/<Profile Name>/extensions/
    • +
  • OS X: ~/Library/Thunderbird/Profiles/<Profile Name>/extensions/
    • +
+

Configure the Great DANE Engine address by navigating to Add-ons -> Great DANE -> Options.

+

License

+

Dual-licensed under Apache License 2.0 and 3-Clause BSD License. See LICENSE.

+ + diff --git a/content/options.js b/content/options.js index ef8686f..d49da9c 100644 --- a/content/options.js +++ b/content/options.js @@ -11,7 +11,7 @@ var console = Cc["@mozilla.org/consoleservice;1"].getService(Ci.nsIConsoleServic * to the "extensions.greatdane.engine_url" preference, which is not directly * accessible to the user. Its value depends on whether the user chooses * to use the Grier Forensics instance, a local instance, or other remote - * instance of the DANE SMIMEA Engine. + * instance of the Great DANE Engine. */ var GreatDANEOptions = { _prefService: null, diff --git a/content/options.xul b/content/options.xul index 82f9ba0..501f155 100644 --- a/content/options.xul +++ b/content/options.xul @@ -1,11 +1,12 @@ - + + + title="Great DANE options" >