Bootstrap the Faulty Onions project

Description

The "Faulty Onions" needs to be bootstrapped, in order to help Onion Service developers and operators test their software/systems.

Tasks

  • Bootstrap repository and basic configuration.
  • Templates:
    • Issue templates:
      • Issue template for when we "move" a ticket from faulty onion services to upstream (C Tor or Arti):
        • Priority: how important is this ticket for funder (block their work or not).
        • Request info about if they can do this and how soon and with how much effort.
        • Sponsor label.
        • Link the new ticket to the ticket where test are track.
    • Merge request template.
  • Utilities:
    • Scripts/services to collect .onion addresses from instances.
    • Script/service to create Onionprobe configuration.
    • Log/metrics collector/analyzer (Grafana, Alloy and Loki, or similar), ingesting logs from instances.
    • Prometheus instance (for Onionprobe and MetricsPort).
    • Makefile.
  • Document:
    • Why Docker Compose layout was not modularized into standalone scenarios (reason: fragments and inclusion do not play along).
    • Create basic project documentation.
    • Maybe listing or including in the following pages:
      • Deployment tools - The Onion Services Ecosystem
      • Development page - The Onion Services Ecosystem
  • Deploy:
    • Deploy the test services somewhere.
    • Using a custom domain (maybe faultyonions.torproject.net or something simpler).

Time estimation

  • Complexity: large (5 days)
  • Uncertainty: high (x2)
  • Reference (adapted)
Edited Mar 23, 2026 by Silvio Rhatto
Assignee Loading
Time tracking Loading