Skip to content

Commit

Permalink
Update how-to
Browse files Browse the repository at this point in the history
  • Loading branch information
Javier Serrano Polo committed Jan 9, 2018
1 parent 7bb5829 commit 5aec3f3
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 14 deletions.
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,23 @@ signatures and filtering by certificate authority.

How-to
------
This is still work in progress. The Firefox extension is usable on Linux, but it
depends on a native back end which needs deployment. You can download the
installer at the [releases](https://github.com/jasp00/signTextJS/releases) page;
run it as root for system-wide availability. Alternatively, you can compile the
application and
[set up](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_manifests#Manifest_location)
the environment.

To work with the Firefox extension, try a
This is still work in progress. The Firefox extension depends on a native back
end which needs deployment. You can download the installer at the
[releases](https://github.com/jasp00/signTextJS/releases) page. The add-on works
on Linux and it is expected to work on Windows 64 and macOS too.

For system-wide availability:
* On Linux, run the installer as root.
* On Windows, the installer will ask you.
* On macOS, do the usual DMG installation.

For per-user availability:
* On Linux, run the installer as the user.
* On Windows, the installer will ask you.
* On macOS, open the DMG and deploy
[manually](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_manifests).

To develop the Firefox extension, try a
[temporary installation](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox).
Alternatively, install the WebExtensions SDK following the directions
[here](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext).
Expand All @@ -29,10 +37,11 @@ execute `web-ext run` to run Firefox with the extension or `web-ext build` to
package the extension. After the extension and the native back end have been
installed, page scripts that call `window.crypto.signText` should "just work".

To compile the native application, you will need `libjsoncpp-dev` and
`libnss3-dev` on Linux. For system-wide availability, `signtextjs_plus` and
`signtextjs_plus.json` should be under
`/usr/lib/mozilla/native-messaging-hosts`.
If there is no installer for your architecture, you can compile the application
and
[set up](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_manifests#Manifest_location)
the environment. The files in directory `travis` have the steps to install
dependencies, compile the native back end, run a test, and build the installer.

Firefox versions prior to 57 should stick with version 0.8.7. You may install
the latest published version
Expand Down
2 changes: 1 addition & 1 deletion webextension/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@
"page": "options/options.html"
},
"permissions": ["nativeMessaging", "storage"],
"version": "0.9.0"
"version": "0.9.1"
}

0 comments on commit 5aec3f3

Please sign in to comment.