documentation/installation.md

   1 # Installation
   2
   3 First off, you need Firefox version 68+ (or a compatible fork) and the
   4 [LegacyFox] shim.
   5 See [README.md] for more information.
   6
   7 [README.md]: ../README.md
   8 [LegacyFox]: https://github.com/girst/LegacyFox
   9
  10
  11 ## ⚠️ NO LONGER AVAILABLE ⚠️<br>Option 1: [addons.mozilla.org] \(AMO)
  12
  13 **<https://addons.mozilla.org/firefox/addon/VimFx>**
  14
  15 You used to be able to follow the above link and hit the green “Install” button
  16 and then be ready to go, but Mozilla has removed all legacy extensions from
  17 their site.
  18
  19 - [Signed][signed] and reviewed by Mozilla.
  20 - Hosted on AMO.
  21 - Automatic updates.
  22
  23 [addons.mozilla.org]: https://addons.mozilla.org/
  24
  25
  26 ## Option 2: [GitHub releases][releases]
  27
  28 Go to VimFx’s [releases] page and click the link to “VimFx.xpi” for the version
  29 you’re interested in (most likely the latest). Firefox should then ask you about
  30 allowing the installation. (If not, download the .xpi file and [open it in
  31 Firefox][open-xpi].)
  32
  33 - [Signed][signed] by Mozilla (but not reviewed).
  34 - Available as a backup alternative, and in case of slow reviews on AMO.
  35 - No automatic updates.
  36
  37 [releases]: https://github.com/akhodakivskiy/VimFx/releases
  38
  39
  40 ## Option 3: Build from source
  41
  42 [Build VimFx] and then [open the produced `build/VimFx.xpi` file][open-xpi].
  43
  44 - [Unsigned][signed].
  45 - Bleeding edge.
  46 - Allows you to fiddle with the code.
  47 - No automatic updates.
  48
  49 [Build VimFx]: tools.md#how-to-build-and-install-the-latest-version-from-source
  50
  51 ### How to install an .xpi file in Firefox
  52
  53 Firefox add-ons are .xpi files (a renamed .zip file—try renaming it to .zip and
  54 open it like any old .zip file to see what’s inside). There are several ways of
  55 installing them:
  56
  57 - Drag and drop the .xpi file into the Firefox window.
  58 - Press ctrl+o and choose the .xpi file.
  59 - Use “Install from file…” in the top-right menu in the Add-ons Manager.
  60
  61
  62 ## What is a signed add-on?
  63
  64 By default it is not possible to install add-ons which haven’t been signed by
  65 Mozilla. In order for an add-on to be signed it must pass some code checks. The
  66 idea is to protect users from malware.
  67
  68 If you’re interested in installing an unsigned add-on (such as if you’ve built
  69 a VimFx .xpi from source yourself), read all about extension signing here:
  70
  71 <https://wiki.mozilla.org/Addons/Extension_Signing>
  72
  73
  74 [open-xpi]: #how-to-install-an-xpi-file-in-firefox
  75 [signed]: #what-is-a-signed-add-on