Go to file

Simone Basso 77973301ac feat(make): implement iOS build (#316 ) Part of https://github.com/ooni/probe/issues/1440. Basically, let us continue to update our build infrastructure so that we can release v3.10.0-beta. Now, it's the turn of iOS.		2021-04-29 10:30:39 +02:00
.github/workflows	feat(make): implement iOS build (#316 )	2021-04-29 10:30:39 +02:00
CLI	refactor: build miniooni from toplevel (#203 )	2021-02-02 15:34:03 +01:00
cmd	fix: disable maxRuntime with --input or --input-file (#305 )	2021-04-07 14:55:04 +02:00
debian	feat(ooniprobe): introduce websites_max_runtime (#273 )	2021-03-30 11:16:12 +02:00
docs	doc: ensure all top dirs have an explanatory README (#214 )	2021-02-03 16:54:00 +01:00
E2E	refactor: redesign how we import assets (#260 )	2021-04-01 16:57:31 +02:00
internal	Prepare 3.10.0-beta release (#313 )	2021-04-28 09:34:14 +02:00
MOBILE	feat(make): implement iOS build (#316 )	2021-04-29 10:30:39 +02:00
pkg	fix(oonimkall): allow Android app to set proxy (#303 )	2021-04-06 14:53:58 +02:00
QA	refactor: redesign how we import assets (#260 )	2021-04-01 16:57:31 +02:00
.gitignore	feat(make): implement iOS build (#316 )	2021-04-29 10:30:39 +02:00
build-android.bash	chore: adapt android scripts to use maven central (#307 )	2021-04-07 20:46:11 +02:00
build-ios.bash	Prepare 3.10.0-beta release (#313 )	2021-04-28 09:34:14 +02:00
build-miniooni.sh	refactor: redesign how we import assets (#260 )	2021-04-01 16:57:31 +02:00
build.sh	refactor: redesign how we import assets (#260 )	2021-04-01 16:57:31 +02:00
CODE_OF_CONDUCT.md	doc: add code of conduct (#157 )	2020-11-03 21:16:04 +01:00
CODEOWNERS	chore: continue merging probe-engine into probe-cli (#211 )	2021-02-03 14:42:51 +01:00
CONTRIBUTING.md	doc: merge the engine and the cli readmes (#215 )	2021-02-03 19:29:12 +01:00
go.mod	Prepare 3.10.0-beta release (#313 )	2021-04-28 09:34:14 +02:00
go.sum	Prepare 3.10.0-beta release (#313 )	2021-04-28 09:34:14 +02:00
LICENSE.md	Add LICENSE.md	2018-07-11 18:06:27 +02:00
make	feat(make): implement iOS build (#316 )	2021-04-29 10:30:39 +02:00
Readme.md	refactor: redesign how we import assets (#260 )	2021-04-01 16:57:31 +02:00
smoketest.sh	fix: import path should be github.com/ooni/probe-cli/v3 (#200 )	2021-02-02 10:32:46 +01:00
testjafar.bash	refactor: enable QA tests and jafar self test (#208 )	2021-02-03 13:20:37 +01:00

Readme.md

OONI Probe Client Library and CLI

The next generation OONI Probe: client library and Command Line Interface.

User setup

Please, follow the instructions at 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. Please, make sure you tag such issues using the ooni/probe-cli label.

Repository organization

Every top-level directory contains an explanatory README file.

Development setup

Be sure you have golang >= 1.16 and a C compiler (when developing for Windows, you need Mingw-w64 installed). You can build using:

go build -v ./cmd/ooniprobe

This will generate a binary called ooniprobe in the current directory.

Android bindings

./build-android.bash

We automatically build Android bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

implementation "org.ooni:oonimkall:VERSION"

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

iOS bindings

./build-ios.bash

We automatically build iOS bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

pod 'oonimkall', :podspec => 'https://dl.bintray.com/ooni/ios/oonimkall-VERSION.podspec'

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Updating dependencies

go get -u -v ./... && go mod tidy

Releasing

Create an issue according to the routine release template and perform any item inside the check-list.