OONI Probe Desktop
This is the desktop implementation of OONI Probe.
Our two primary target platforms are:
- Windows > 7 (we may also support older versions, but not as primary tagets)
Moreover, since it's written in electron, we plan on also supporting Linux desktop users.
For some background on the decision to use electron and the libraries we chose to use, see: Writing a modern cross-platform desktop app.
In order to start hacking on this, we assume you have
Then you can run:
You will also need to have copied a compiled binary of
probe-cli into the
directory for the platform you plan to do development on.
You can download them by running:
yarn run download-bin
To build and run a development mode electron instance run:
yarn run start
To create a signed packaged app you will need to have configured the following environment variables:
CSC_NAME=Hermes OONI Dev Key APPLEIDPASS=XXXX APPLEIDemail@example.com CSC_LINK=/path/to/secrets/file.p12 CSC_KEY_PASSWORD=XXXX
You can place them inside of
.env file and they will be picked up by the
following build commands:
yarn run pack:mac yarn run pack:win
To make a linux build run:
yarn run pack:linux
To publish a release you should run:
yarn run publish
Important caveat be sure to not push the tag for the upcoming release until
yarn run publish command has run successfully. If you do so users
of the OONI Probe Desktop app will get an error when they start the app because
the auto-update system will try to fetch the metadata associated with that tag.