diff --git a/docs/OONIProbeLegacyCompatibility.md b/docs/OONIProbeLegacyCompatibility.md index d5b2f15..9a9ea36 100644 --- a/docs/OONIProbeLegacyCompatibility.md +++ b/docs/OONIProbeLegacyCompatibility.md @@ -1,39 +1,39 @@ # Command line flags `-h, --help` Display help and exit -Supported: yes +Supported: ✅ probe-cli equivalent: `-h, --help` `-n, --no-collector` Disable writing to collector -Supported: no +Supported: ❌ Priority: high `-N, --no-njson` Disable writing to disk -Supported: no +Supported: ❌ Priority: low `-g, --no-geoip` Disable geoip lookup on start. -Supported: no +Supported: ❌ Priority: low `-s, --list` List the currently installed ooniprobe nettests -Supported: no +Supported: ❌ Priority: low `-w, --web-ui` Start the web UI -Supported: no +Supported: ❌ Priority: wontfix, we have no web UI in probe-cli `-z, --initialize` Initialize ooniprobe to begin running it -Supported: yes +Supported: ✅ probe-cli equivalent: `ooniprobe onboard` `-o, --reportfile PATH_TO_FILE` Specify the report file name to write to. -Supported: no +Supported: ❌ Priority: medium `-i, --testdeck PATH_TO_DECK` Specify as input a test deck: a yaml file containing the tests to run and their arguments. -Supported: no +Supported: ❌ Priority: wontfix, we have no deck support `-c, --collector COLLECTOR_ADDRESS` Specify the address of the collector for test results. In most cases a user will prefer to specify a bouncer over this. @@ -45,27 +45,27 @@ Supported: partially probe-cli equivalent: edit ooniprobe.conf to specify the bouncer address in the options `-l, --logfile PATH_TO_LOGFILE` Write to this logs to this filename. -Supported: no +Supported: ❌ Priority: medium `-O, --pcapfile PATH_TO_PCAPFILE` Write a PCAP of the ooniprobe session to this filename. -Supported: no +Supported: ❌ Priority: wontfix, we don't have packet capture support in probe-cli `-f, --configfile PATH_TO_CONFIG` Specify a path to the ooniprobe configuration file. -Supported: yes +Supported: ✅ probe-cli equivalent: `--config` `-d, --datadir` Specify a path to the ooniprobe data directory. -Supported: yes +Supported: ✅ probe-cli equivalent: set the `OONI_HOME` environment variable `-a, --annotations key:value[,key2:value2]` Annotate the report with a key:value[, key:value] format. -Supported: yes +Supported: ✅ Priority: high `-P, --preferred-backend onion|https|cloudfront` Set the preferred backend to use when submitting results and/or communicating with test helpers. Can be either onion, https or cloudfront -Supported: no +Supported: ❌ Priority: wontfix, we don't support any other backend beyond https, yet we will and yet we would prefer to have the logic of reporting be managed by the probe itself and not expose this setting. @@ -73,46 +73,46 @@ itself and not expose this setting. # Features * Run a test deck -Supported: yes +Supported: ✅ probe-cli equivalent: we now call a test deck a test group and we have them coded into the logic of the client * Run an individual netttest -Supported: no +Supported: ❌ Priority: medium * Upload a measurement like `oonireport upload` -Supported: no +Supported: ❌ Priority: medium * Test an individual URL with web_connectivity -Supported: no +Supported: ❌ Priority: high * Run tests automatically like `ooniprobe-agent` -Supported: no +Supported: ❌ Priority: high * Write custom tests like OONI test templates -Supported: no +Supported: ❌ Priority: medium * Packet captures -Supported: no +Supported: ❌ Priority: low * Upload measurements using onion services -Supported: no +Supported: ❌ Priority: low * Log level support to aid debugging -Supported: no +Supported: ❌ Priority: medium * Measurement quota to limit the disk usage -Supported: no +Supported: ❌ Priority: high * Failover strategies for uploading measurements (use https then onion then cloudfront) -Supported: no +Supported: ❌ Priority: high