c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use emoji to make things more readable

Browse Source
This commit is contained in:
Arturo Filastò 2019-11-29 17:24:16 +01:00
parent d51b535153
commit 6f099bb3e0
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/OONIProbeLegacyCompatibility.md
View File

@ -1,39 +1,39 @@
# Command line flags # Command line flags
`-h, --help` Display help and exit `-h, --help` Display help and exit
Supported: yes Supported: ✅
probe-cli equivalent: `-h, --help` probe-cli equivalent: `-h, --help`
`-n, --no-collector` Disable writing to collector `-n, --no-collector` Disable writing to collector
Supported: no Supported: ❌
Priority: high Priority: high
`-N, --no-njson` Disable writing to disk `-N, --no-njson` Disable writing to disk
Supported: no Supported: ❌
Priority: low Priority: low
`-g, --no-geoip` Disable geoip lookup on start. `-g, --no-geoip` Disable geoip lookup on start.
Supported: no Supported: ❌
Priority: low Priority: low
`-s, --list` List the currently installed ooniprobe nettests `-s, --list` List the currently installed ooniprobe nettests
Supported: no Supported: ❌
Priority: low Priority: low
`-w, --web-ui` Start the web UI `-w, --web-ui` Start the web UI
Supported: no Supported: ❌
Priority: wontfix, we have no web UI in probe-cli Priority: wontfix, we have no web UI in probe-cli
`-z, --initialize` Initialize ooniprobe to begin running it `-z, --initialize` Initialize ooniprobe to begin running it
Supported: yes Supported: ✅
probe-cli equivalent: `ooniprobe onboard` probe-cli equivalent: `ooniprobe onboard`
`-o, --reportfile PATH_TO_FILE` Specify the report file name to write to. `-o, --reportfile PATH_TO_FILE` Specify the report file name to write to.
Supported: no Supported: ❌
Priority: medium Priority: medium
`-i, --testdeck PATH_TO_DECK` Specify as input a test deck: a yaml file containing the tests to run and their arguments. `-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 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. `-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 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. `-l, --logfile PATH_TO_LOGFILE` Write to this logs to this filename.
Supported: no Supported: ❌
Priority: medium Priority: medium
`-O, --pcapfile PATH_TO_PCAPFILE` Write a PCAP of the ooniprobe session to this filename. `-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 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. `-f, --configfile PATH_TO_CONFIG` Specify a path to the ooniprobe configuration file.
Supported: yes Supported: ✅
probe-cli equivalent: `--config` probe-cli equivalent: `--config`
`-d, --datadir` Specify a path to the ooniprobe data directory. `-d, --datadir` Specify a path to the ooniprobe data directory.
Supported: yes Supported: ✅
probe-cli equivalent: set the `OONI_HOME` environment variable 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. `-a, --annotations key:value[,key2:value2]` Annotate the report with a key:value[, key:value] format.
Supported: yes Supported: ✅
Priority: high 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 `-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 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 and yet we would prefer to have the logic of reporting be managed by the probe
itself and not expose this setting. itself and not expose this setting.
@ -73,46 +73,46 @@ itself and not expose this setting.
# Features # Features
* Run a test deck * Run a test deck
Supported: yes Supported: ✅
probe-cli equivalent: we now call a test deck a test group and we have them probe-cli equivalent: we now call a test deck a test group and we have them
coded into the logic of the client coded into the logic of the client
* Run an individual netttest * Run an individual netttest
Supported: no Supported: ❌
Priority: medium Priority: medium
* Upload a measurement like `oonireport upload` * Upload a measurement like `oonireport upload`
Supported: no Supported: ❌
Priority: medium Priority: medium
* Test an individual URL with web_connectivity * Test an individual URL with web_connectivity
Supported: no Supported: ❌
Priority: high Priority: high
* Run tests automatically like `ooniprobe-agent` * Run tests automatically like `ooniprobe-agent`
Supported: no Supported: ❌
Priority: high Priority: high
* Write custom tests like OONI test templates * Write custom tests like OONI test templates
Supported: no Supported: ❌
Priority: medium Priority: medium
* Packet captures * Packet captures
Supported: no Supported: ❌
Priority: low Priority: low
* Upload measurements using onion services * Upload measurements using onion services
Supported: no Supported: ❌
Priority: low Priority: low
* Log level support to aid debugging * Log level support to aid debugging
Supported: no Supported: ❌
Priority: medium Priority: medium
* Measurement quota to limit the disk usage * Measurement quota to limit the disk usage
Supported: no Supported: ❌
Priority: high Priority: high
* Failover strategies for uploading measurements (use https then onion then cloudfront) * Failover strategies for uploading measurements (use https then onion then cloudfront)
Supported: no Supported: ❌
Priority: high Priority: high