Use upstream's email wizard javascript utilities.
[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   - File -> New -> Bitmask account.
10   - Edit -> Account Settings... -> Account Actions -> Add Bitmask Accont.
11 * Caching prevention: accounts are created with caching turned off and the
12   UI is modified to prevent users from turning on caching for these
13   accounts.
14
15 Development/testing
16 -------------------
17
18 For development/testing purposes you can create a text file in Thunderbird's
19 extension directory whose contents point to the repository dir:
20
21 * The file must be created in the `~/.thunderbird/<profile>/extensions/`
22   directory.
23 * The file name must be `bitmask-thunderbird@leap.se`.
24 * The file contents must be the path for this repository.
25
26 XPI Package
27 -----------
28
29 To generate an unsigned XPI package, type the following inside the root of the
30 repository:
31
32   make DEFAULTKEY=<key id>
33
34 This command will:
35
36 * Generate a `.xpi` file inside the `build/` directory.
37 * Create a `build/SHA512SUMS` file containing the sha512 hash of the `.xpi` file.
38 * Sign that file with the given `DEFAULTKEY` and create a `build/SHA512SUMS.gpg` file.
39
40 You can now use the generated `.xpi` file install the package as a normal
41 Thunderbird extension.
42
43 Signed XPI package
44 ------------------
45
46 To generate a signed XPI package you must first have a certificate and then do
47 the following:
48
49   make signed CERTDIR=<path to cert dir> CERTNAME=<cert name> DEFAULTKEY=<key id>
50
51 This command will:
52
53 * Generate a signed `.xpi` file inside the `build/` directory using the
54   `CERTNAME` certificate contained in `CERTDIR`.
55 * Create a `build/SHA512SUMS` file containing the sha512 hash of the `.xpi` file.
56 * Sign that file with the given `DEFAULTKEY` and create a `build/SHA512SUMS.gpg` file.
57
58 For more information about signed `.xpi` files, see:
59 https://developer.mozilla.org/en-US/docs/Signing_a_XPI