Fix makefile and install.rdf template.
[bitmask_thunderbird.git] / README.rst
1 Bitmask Thunderbird Extension
2 =============================
3
4 The Bitmask Thunderbird Extension provides:
5
6 * A wizard for creating email accounts with IMAP/SMTP configuration targeted
7   to localhost and the default Bitmask client ports. There are different ways to
8   launch the wizard for configuring a Bitmask Account:
9   - Clicking on the statusbar notification.
10   - File -> New -> Bitmask account.
11   - Edit -> Account Settings... -> Account Actions -> Add Bitmask Accont.
12 * Caching prevention: accounts are created with caching turned off and the
13   UI is modified to prevent users from turning on caching for these
14   accounts.
15
16 Development/testing
17 -------------------
18
19 For development/testing purposes you can create a text file in Thunderbird's
20 extension directory whose contents point to the repository dir:
21
22 * The file must be created in the `~/.thunderbird/<profile>/extensions/`
23   directory.
24 * The file name must be `bitmask-thunderbird@leap.se`.
25 * The file contents must be the path for the `src/` directory inside this
26   repository.
27
28 XPI Package
29 -----------
30
31 To generate an unsigned XPI package, type the following inside the root of the
32 repository:
33
34   make DEFAULTKEY=<key id>
35
36 This command will:
37
38 * Generate a `.xpi` file inside the `build/` directory.
39 * Create a `build/SHA512SUMS` file containing the sha512 hash of the `.xpi` file.
40 * Sign that file with the given `DEFAULTKEY` and create a `build/SHA512SUMS.gpg` file.
41
42 You can now use the generated `.xpi` file install the package as a normal
43 Thunderbird extension.
44
45 Signed XPI package
46 ------------------
47
48 To generate a signed XPI package you must first have a certificate and then do
49 the following:
50
51   make sign CERTDIR=<path to cert dir> CERTNAME=<cert name> DEFAULTKEY=<key id>
52
53 This command will:
54
55 * Generate a signed `.xpi` file inside the `build/` directory using the
56   `CERTNAME` certificate contained in `CERTDIR`.
57 * Create a `build/SHA512SUMS` file containing the sha512 hash of the `.xpi` file.
58 * Sign that file with the given `DEFAULTKEY` and create a `build/SHA512SUMS.gpg` file.
59
60 For more information about signed `.xpi` files, see:
61 https://developer.mozilla.org/en-US/docs/Signing_a_XPI