ooniprobe custom deck

instructions.md

How to setup custom decks

1. Discover where the deck should be written to by running:*

$ ooniprobe --info

(The path you care about is the one for "decks available directory")

2. Write your custom deck file to:

/path/to/decks-available/my-custom-deck.yaml

Be sure to replace the /path/to/url-list.txt to a location where you have written the url-list.txt and be sure to use absolute paths.

4. Restart the ooniprobe daemon (optional).

(Note: you can also avoid restarting the daemon and just wait I think 30 minutes for the deck list to be refreshed automatically)

5. Go the web UI (http://lepidopter.local) and click on the hourglass icon to enable the deck. If you don’t see it wait a little bit.

my-custom-deck.yaml

---
name: My Custom Deck
description: "This is a description for my custom deck that will appear in the web UI."
schedule: "@daily"
icon: "fa-hashtag"
tasks:

- name: Runs the Web Connectivity Test
  ooni:
    test_name: web_connectivity
    file: /path/to/url-list.txt

url-list.txt

https://example.com/
http://other-example.net/