Get domains for some Onion Service projects

Goals

  • Get shorter URLs for some Onion Service related projects, pointing to their GitLab Pages.

Why

  • The current URLs are hard to remember and take a lot to type.

Approaches

Per-project domains

This approach consists in having one domain per project:

  • onionplan.torproject.org (for The Onion Plan).
  • onionbalance.torproject.org (for Onionbalance).
  • onionprobe.torproject.org (for Onionprobe).
  • oniongroove.torproject.org (for Oniongroove).
  • onion-launchpad.torproject.org (for Onion Launchpad).
  • onionspray.torproject.org (for Onionspray) (see this issue about rebranding the EOTK fork).
  • onionmine.torproject.org (for Onionmine, check onionmine#26 (closed)).

Pros:

  • Tend to produce shorter URLs.

Cons:

  • Involves more work to setup.

Single Onion Service documentation site

This approach consists in having a single onionservices.torproject.org domain, and allocating a subpath for each project:

  • onionservices.torproject.org/onionplan (for The Onion Plan).
  • onionservices.torproject.org/onionbalance (for Onionbalance, check onionbalance#28 (closed)).
  • onionservices.torproject.org/onionprobe (for Onionprobe).
  • onionservices.torproject.org/oniongroove (for Oniongroove).
  • onionservices.torproject.org/onion-launchpad (for Onion Launchpad).
  • onionservices.torproject.org/onionspray (for Onionspray) (see this issue about rebranding the EOTK fork).
  • onionservices.torproject.org/onionmine (for Onionmine, check onionmine#26 (closed)).

Pros:

  • Can be easier for a sysadmin point of view.
  • It's self-explanatory.
  • May have integrated search across all these projects by leveraging these configurations:
    • mkdocs-multirepo-plugin · PyPI
    • Built-in projects plugin - Material for MkDocs
  • Could be release as part of the Onion Services 20th Years Anniversary (2024 edition).

Cons:

  • May conflict/duplicate efforts with the upcoming Tor Developer Portal.
  • Requires an additional home page.

Deployment options

  1. Have a static hosting endpoint with changes pushed by GitLab CI jobs, possibly the static shim deploying to the static component.
  2. A reverse proxy setup.
  3. Or it may happen that only a redirect/alias is supported (like was done at tpo/tpa/team#40294 (closed)).

Bonus

  • Onion Services endpoint and Onion-Location for each site. The Onion Service itself could be one for the entire GitLab pages (and that would also help with onion-launchpad#32, related to tpo/tpa/team#40379).
Edited Feb 20, 2024 by Silvio Rhatto
Assignee Loading
Time tracking Loading