fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-12 21:30:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add quick read to top of overview

Browse source
This commit is contained in:
Owen Schwartz 2025-01-05 11:39:42 -05:00
parent 4ebc95ef4b
commit f99a334dd8
No known key found for this signature in database
GPG key ID: 8271FDFFD9E0CCBD
2 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/docusaurus/docs/01-overview.md
View file

@ -2,6 +2,8 @@
The Fossorial system - with Pangolin at its core - is a self-hosted tunneled reverse proxy with identity and access management, designed to securely expose private resources through encrypted [WireGuard](https://www.WireGuard.com/) tunnels running in user space. Think self hosted Cloudflare tunnels.
Pangolin uses Traefik under the hood to do the actual HTTP proxying. A plugin, Badger, provides a way to authenticate every request with Pangolin. A second service, Gerbil, provides a WireGuard management server that Pangolin can use to create peers for connectivity. And finally, there is Newt, a CLI tool and Docker container that connects back to Newt and Gerbil with WireGuard fully in user space and proxies your local resources. This means that you do not need to run a privileged process or container in order to expose your services!
## Components Overview
Fossorial has a couple major components:

2
packages/docusaurus/docs/07-roadmap.md
View file

@ -66,4 +66,4 @@ Are you experienced with authentication procedures and best practices? We would
### SAAS
We intend at some point to provide Pangolin in a hosted offering with pricing competitive to generally available cloud VPS services. This way users who would like to use Pangolin but don't want to manage their own VPS can do so and help to fund future development.
We intend at some point to provide Pangolin in a hosted offering with a healthy free tier and pricing competitive to generally available cloud VPS services. This way users who would like to use Pangolin - but don't want to manage their own VPS - can do so and help to fund future development.