Skip to content

Commit

Permalink
Update README.md (#134)
Browse files Browse the repository at this point in the history
  • Loading branch information
T0biii authored Apr 21, 2024
1 parent 435daa0 commit acf08a9
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,15 @@ wgkex is a WireGuard key exchange and management tool designed and run by FFMUC.
WireGuard Key Exchange is a tool consisting of two parts: a frontend (broker) and a backend (worker). These components
communicate to each other via MQTT - a messaging bus.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="Docs/architecture-dark.png">
<source media="(prefers-color-scheme: light)" srcset="Docs/architecture.png">
<img src="Docs/architecture.png" alt="Architectural Diagram">
</picture>
```mermaid
graph TD;
A{"client"} -->|"RESTful API"| G("WGKex Broker")
G -->|"publish"| B("Mosquitto")
C("WGKex Worker") -->|"Subscribe"| B
C -->|"Route Injection"| D["netlink (pyroute2)"]
C -->|"Peer Creation"| E["wireguard (pyroute2)"]
C -->|"VxLAN FDB Entry"| F["VXLAN FDB (pyroute2)"]
```

### Frontend broker

Expand Down

0 comments on commit acf08a9

Please sign in to comment.