# anderspitman/awesome-tunneling architecture

> Architecture diagram of the GitHub repository anderspitman/awesome-tunneling, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/anderspitman/awesome-tunneling
- Repository: https://github.com/anderspitman/awesome-tunneling

## Overview

This repository is primarily a curated comparison list of tunneling solutions, aimed at self-hosters and developers. Its small runtime utility sorts entries in the README’s open-source section by GitHub stars: it reads the section, resolves repository names, fetches or reuses cached counts, reports results, and can rewrite the list (or only check it). The graph focuses on that implemented workflow, not the tunneling products described by the list. Evidence is limited to the README and the single sampled script.

Main entry points: [`scripts/sort_by_stars.py`](https://github.com/anderspitman/awesome-tunneling/blob/master/scripts/sort_by_stars.py) (Star sorter), [`README.md`](https://github.com/anderspitman/awesome-tunneling/blob/master/README.md) (Tunneling list)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_user(("List maintainer"))
node_sorter["Star sorter<br/>[sort_by_stars.py]"]
node_readme["Tunneling list<br/>[README.md]"]
node_github["GitHub API"]
node_cache[("Star cache")]
node_terminal["CLI output"]

node_user -->|"runs"| node_sorter
node_sorter -->|"reads and rewrites"| node_readme
node_sorter -->|"loads and saves"| node_cache
node_sorter -->|"fetches counts"| node_github
node_sorter -->|"prints report"| node_terminal

click node_sorter "https://github.com/anderspitman/awesome-tunneling/blob/master/scripts/sort_by_stars.py"
click node_readme "https://github.com/anderspitman/awesome-tunneling/blob/master/README.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_user,node_terminal toneIndigo
class node_sorter,node_readme toneTeal
class node_github toneMint
class node_cache toneAmber
```

## Components

### Other components

- **List maintainer**
- [Star sorter](https://github.com/anderspitman/awesome-tunneling/blob/master/scripts/sort_by_stars.py): `scripts/sort_by_stars.py`
- [Tunneling list](https://github.com/anderspitman/awesome-tunneling/blob/master/README.md): `README.md`
- **GitHub API**
- **Star cache**
- **CLI output**

## Connections

- List maintainer → Star sorter: runs (evidence: `scripts/sort_by_stars.py`)
- Star sorter → Tunneling list: reads and rewrites (evidence: `scripts/sort_by_stars.py`)
- Star sorter → Star cache: loads and saves (evidence: `scripts/sort_by_stars.py`)
- Star sorter → GitHub API: fetches counts (evidence: `scripts/sort_by_stars.py`)
- Star sorter → CLI output: prints report (evidence: `scripts/sort_by_stars.py`)
