{"id":22264267,"url":"https://github.com/torproject/onionprobe-role","last_synced_at":"2025-10-16T02:32:01.266Z","repository":{"id":264646621,"uuid":"892158707","full_name":"torproject/onionprobe-role","owner":"torproject","description":"Onionprobe Ansible Role -- mirror of https://gitlab.torproject.org/tpo/onion-services/ansible/onionprobe-role/ -- please create issues and pull requests there ","archived":false,"fork":false,"pushed_at":"2025-03-13T14:02:35.000Z","size":226,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-13T15:21:53.282Z","etag":null,"topics":["ansible-role","onion-services","tor"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/torproject.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://donate.torproject.org"]}},"created_at":"2024-11-21T15:57:15.000Z","updated_at":"2025-03-13T14:02:39.000Z","dependencies_parsed_at":"2024-12-09T20:21:49.121Z","dependency_job_id":"c07ac037-4887-4cfe-8d89-ee6cc27e2849","html_url":"https://github.com/torproject/onionprobe-role","commit_stats":null,"previous_names":["torproject/onionprobe-role"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torproject%2Fonionprobe-role","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torproject%2Fonionprobe-role/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torproject%2Fonionprobe-role/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torproject%2Fonionprobe-role/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/torproject","download_url":"https://codeload.github.com/torproject/onionprobe-role/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245476718,"owners_count":20621698,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible-role","onion-services","tor"],"created_at":"2024-12-03T10:08:21.969Z","updated_at":"2025-10-16T02:32:01.261Z","avatar_url":"https://github.com/torproject.png","language":"Jinja","funding_links":["https://donate.torproject.org"],"categories":[],"sub_categories":[],"readme":"# Ansible role for Onionprobe\n\nThis [Ansible][] role manages [Onionprobe][], a monitoring tool for [Tor Onion\nServices][].\n\nIt can install [Onionprobe][] from it's [Git][] repository, [from PyPI][]\nor using a distribution-provided package (if available).\n\nIt can configure [Onionprobe][] to run as a single service or in the\n[standalone][] mode.\n\n[Ansible]: https://ansible.com\n[Onionprobe]: https://gitlab.torproject.org/tpo/onion-services/onionprobe\n[Tor Onion Services]: https://community.torproject.org/onion-services/\n[Git]: https://git-scm.com\n[from PyPI]: https://pypi.org/project/onionprobe/\n\n## Supported systems\n\nTested and supported:\n\n* [Debian](https://debian.org).\n\nSupported:\n\n* [Ubuntu](https://ubuntu.com).\n\nOther systems may have only _partial_ support:\n\n* Installation from distro package may not be supported.\n* Service management may be only partially supported.\n\nMerge requests are welcome to cover more Operating Systems.\n\n## Requirements\n\n* [Ansible][].\n* [Systemd][], if the service is to be managed.\n* The requirements to run [ansible.builtin.pip][] if installing Onionprobe [from PyPI][].\n* For the [standalone][] operation mode:\n  * [Docker][] and [Docker Compose][], or [Podman][] and [Podman Compose][] should be\n    available in the remote system. As of 2024-10, [Podman][] support is still\n    [experimental][podman-experimental].\n\n[Systemd]: https://systemd.io\n[ansible.builin.pip]: https://docs.ansible.com/ansible/latest/collections/ansible/builtin/pip_module.html\n[standalone]: https://onionservices.torproject.org/apps/web/onionprobe/standalone/\n[Docker]: https://docker.com\n[Podman]: https://podman.io\n[Docker Compose]: https://docs.docker.com/compose/\n[Podman Compose]: https://github.com/containers/podman-compose\n[podman-experimental]: https://gitlab.torproject.org/tpo/onion-services/ansible/onionprobe-role/-/issues/1#note_3125493\n\n## Installation\n\nThis role can be installed directly through [Ansible Galaxy][]:\n\n    ansible-galaxy role install torproject.onionprobe\n\nIt's also possible to clone it directly from the [upstream repository][].\nA [GitHub mirror][] is also provided.\n\n[Ansible Galaxy]: https://galaxy.ansible.com\n[upstream repository]: https://gitlab.torproject.org/tpo/onion-services/ansible/onionprobe-role\n[GitHub mirror]: https://github.com/torproject/onionprobe-role/\n\n## Usage\n\nSample usage in an Ansible playbook for a simple monitoring service:\n\n```yaml\n- name: Onionprobe prober\n  hosts: my-onion-prober\n\n  roles:\n    - onionprobe\n\n  vars:\n    # Installs Onionprobe using the distribution package manager\n    onionprobe_installation: distro\n\n    # Set operation to \"single\" mode (i.e, just the Onionprobe service)\n    onionprobe_operation: single\n\n    # Monitors SecureDrop instances\n    onionprobe_config: securedrop.yml\n```\n\nAnother example, this time for the full [standalone][] node:\n\n```yaml\n- name: Onionprobe standalone monitor\n  hosts: my-onion-monitor\n\n  roles:\n    - onionprobe\n\n  vars:\n    # Installs Onionprobe from it's Git repository\n    onionprobe_installation: repository\n\n    # Sets operation to standalone (containerized services)\n    onionprobe_operation: standalone\n\n```\n\n## Configuration\n\nCheck [defaults/main.yml](defaults/main.yml) for a commented list of variables.\n\n## Development\n\nThis role has [molecule tests](molecule):\n\n* The `podman` scenario is a generic one and is well suited for testing both\n  locally and through CI.\n* The `local` scenario actually applies the configuration into the running\n  node, so be careful were to run it.\n\nA [Makefile](Makefile) exists to help local testing, which relies on\n[AnCIble][] to be available somewhere. Details in how to use it are given\n[here][].\n\n[AnCIble]: https://gitlab.torproject.org/tpo/onion-services/ansible/ancible/\n[here]: https://gitlab.torproject.org/tpo/onion-services/ansible/ancible/-/blob/main/README.md#development\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorproject%2Fonionprobe-role","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftorproject%2Fonionprobe-role","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorproject%2Fonionprobe-role/lists"}