b2209bb637
This pull request fixes https://github.com/ooni/probe/issues/1471. We have replaced the original build script (`./make`) with the `./mk` makefile (executable using `#!/usr/bin/make -f`). We concluded supporting direct builds from Windows is not worth the effort and halving the code we need to maintain is probably a good plus. Both macOS and Linux install GNU make at `/usr/bin/make`, so we should be okay in the common use cases. I significantly simplified the management of Go versioning by requiring the user to manage it and by enforcing that we are using the desired Go version. This speeds up builds and works in sane operating systems that use the last version of a specific package. Otherwise, it's possible to use the `go get golang.org/dl/go${version}` feature. The remaining question mark was related to updating the Android SDK. I have determined that a good course of action is pinning to the latest CLI tools and always forcing the CLI tools to install the latest required packages (e.g., the NDK).
88 lines
3.4 KiB
Markdown
88 lines
3.4 KiB
Markdown
# OONI Probe Client Library and CLI
|
|
|
|
[](https://godoc.org/github.com/ooni/probe-cli) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Ashorttests) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Aalltests) [](https://coveralls.io/github/ooni/probe-cli?branch=master) [](https://goreportcard.com/report/github.com/ooni/probe-cli) [](https://github.com/ooni/probe-cli/actions?query=workflow%3Alinux-debian-packages) [](https://github.com/ooni/probe/labels/ooni%2Fprobe-cli)
|
|
|
|
The next generation OONI Probe: client library and Command Line Interface.
|
|
|
|
## User setup
|
|
|
|
Please, follow the instructions at [ooni.org/install/cli](https://ooni.org/install/cli)
|
|
to install `ooniprobe`. If we do not support your use case, please let us know.
|
|
|
|
Once `ooniprobe` is installed, try `ooniprobe help` to get interactive help.
|
|
|
|
## Reporting issues
|
|
|
|
Please, report issues with this codebase at [github.com/ooni/probe](
|
|
https://github.com/ooni/probe/issues/new?labels=ooni/probe-cli&assignee=bassosimone).
|
|
Please, make sure you tag such issues using the `ooni/probe-cli` label.
|
|
|
|
## Repository organization
|
|
|
|
Every top-level directory contains an explanatory README file.
|
|
|
|
## OONIProbe
|
|
|
|
Be sure you have golang >= 1.16 and a C compiler (when developing for Windows, you
|
|
need Mingw-w64 installed). You can build using:
|
|
|
|
```bash
|
|
go build -v ./cmd/ooniprobe
|
|
```
|
|
|
|
This will generate a binary called `ooniprobe` in the current directory.
|
|
|
|
## Android bindings
|
|
|
|
Make sure you have GNU make installed, then run:
|
|
|
|
```bash
|
|
./mk android
|
|
```
|
|
|
|
Builds bindings for Android. (Add `OONI_PSIPHON_TAGS=""` if you
|
|
cannot clone private repositories in the https://github.com/ooni namespace.)
|
|
|
|
The generated bindings are (manually) pushed to the Maven Central package
|
|
repository. The instructions explaining how to integrate these bindings
|
|
are published along with the release notes.
|
|
|
|
## iOS bindings
|
|
|
|
Make sure you have GNU make installed, then run:
|
|
|
|
```bash
|
|
./mk ios
|
|
```
|
|
|
|
Builds bindings for iOS. (Add `OONI_PSIPHON_TAGS=""` if you
|
|
cannot clone private repositories in the https://github.com/ooni namespace.)
|
|
|
|
The generated bindings are (manually) added to GitHub releases. The instructions
|
|
explaining how to integrate these bindings are published along with the release notes.
|
|
|
|
## miniooni
|
|
|
|
Miniooni is the experimental OONI client used for research. Compile using:
|
|
|
|
```bash
|
|
go build -v ./internal/cmd/miniooni
|
|
```
|
|
|
|
This will generate a binary called `miniooni` in the current directory.
|
|
|
|
## Updating dependencies
|
|
|
|
```bash
|
|
go get -u -v ./... && go mod tidy
|
|
```
|
|
|
|
## Releasing
|
|
|
|
Create an issue according to [the routine release template](
|
|
https://github.com/ooni/probe/blob/master/.github/ISSUE_TEMPLATE/routine-sprint-releases.md)
|
|
and perform any item inside the check-list.
|
|
|
|
We build releases using `./mk`, which requires GNU make. Try
|
|
the `./mk help|less` command for detailed usage.
|