From cc4f1eb87193cbc6cbcfab2a130a88ef67a60adf Mon Sep 17 00:00:00 2001 From: miloschwartz Date: Tue, 15 Apr 2025 17:11:04 -0400 Subject: [PATCH] fix formatting in overview --- packages/docusaurus/docs/01-overview.md | 27 +++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/packages/docusaurus/docs/01-overview.md b/packages/docusaurus/docs/01-overview.md index c846875..93c0198 100644 --- a/packages/docusaurus/docs/01-overview.md +++ b/packages/docusaurus/docs/01-overview.md @@ -32,7 +32,15 @@ Fossorial has a couple major components: ### [**Pangolin**](https://github.com/fosrl/pangolin) (Management Application & Central Server) -The central hub for managing the application. Pangolin includes: - Most business logic. - External facing rest API. - WebSocket server for managing Newt sites. - Internal facing rest API for communication between components on the VPS. - Frontend server for the web interface. - Main database for storing data. - Authentication system. +The central hub for managing the application. Pangolin includes: + +- Most business logic. +- External facing rest API. +- WebSocket server for managing Newt sites. +- Internal facing rest API for communication between components on the VPS. +- Frontend server for the web interface. +- Main database for storing data. +- Authentication system. ### [**Gerbil**](https://github.com/fosrl/gerbil) (WireGuard Interface Management) @@ -40,17 +48,24 @@ Acts as the intermediary for managing WireGuard configurations. It creates and m ### [**Traefik**](https://github.com/traefik/traefik) (Reverse Proxy) -A high-performance, modular reverse proxy that routes requests to private resources. Traefik is widely adopted, and its plugin system allows further customization and security enhancements. For example: - Out-of-the-box compatibility with plugins like [Fail2Ban](https://plugins.traefik.io/plugins/628c9ebcffc0cd18356a979f/fail2-ban) or [CrowdSec](https://plugins.traefik.io/plugins/6335346ca4caa9ddeffda116/crowdsec-bouncer-traefik-plugin). - Enhanced security via our custom Traefik plugin Badger, which acts as an authentication bouncer. +A high-performance, modular reverse proxy that routes requests to private resources. Traefik is widely adopted, and its plugin system allows further customization and security enhancements. For example: + +- Enhanced security via our custom Traefik plugin Badger, which acts as an authentication bouncer. +- Out-of-the-box compatibility with plugins like GeoBlock and CrowdSec. ### [**Badger**](https://github.com/fosrl/badger) (Traefik Plugin Middleware): - A custom Traefik plugin that acts as an authentication bouncer. Badger: - - Intercepts requests to the Traefik reverse proxy. - - Redirects unauthenticated requests to the Pangolin server for authentication. +A custom Traefik plugin that acts as an authentication bouncer. Badger: + +- Intercepts requests to the Traefik reverse proxy. +- Redirects unauthenticated requests to the Pangolin server for authentication. ### [**Newt**](https://github.com/fosrl/newt) (Minimal User Space WireGuard Client) -A lightweight client designed to run on the private network. Newt: - Connects to the Pangolin server via WebSocket and Gerbil via fully user space WireGuard - Facilitates networking through its connection to Gerbil and creating TCP proxies +A lightweight client designed to run on the private network. Newt: + +- Connects to the Pangolin server via WebSocket and Gerbil via fully user space WireGuard +- Facilitates networking through its connection to Gerbil and creating TCP proxies ## System Diagram