Remove status bar messages (#4871).
[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 this repository.
26
27 XPI Package
28 -----------
29
30 To generate an unsigned XPI package, type the following inside the root of the
31 repository:
32
33   make DEFAULTKEY=<key id>
34
35 This command will:
36
37 * Generate a `.xpi` file inside the `build/` directory.
38 * Create a `build/SHA512SUMS` file containing the sha512 hash of the `.xpi` file.
39 * Sign that file with the given `DEFAULTKEY` and create a `build/SHA512SUMS.gpg` file.
40
41 You can now use the generated `.xpi` file install the package as a normal
42 Thunderbird extension.
43
44 Signed XPI package
45 ------------------
46
47 To generate a signed XPI package you must first have a certificate and then do
48 the following:
49
50   make signed CERTDIR=<path to cert dir> CERTNAME=<cert name> DEFAULTKEY=<key id>
51
52 This command will:
53
54 * Generate a signed `.xpi` file inside the `build/` directory using the
55   `CERTNAME` certificate contained in `CERTDIR`.
56 * Create a `build/SHA512SUMS` file containing the sha512 hash of the `.xpi` file.
57 * Sign that file with the given `DEFAULTKEY` and create a `build/SHA512SUMS.gpg` file.
58
59 For more information about signed `.xpi` files, see:
60 https://developer.mozilla.org/en-US/docs/Signing_a_XPI