mirror of
https://github.com/fosrl/pangolin.git
synced 2025-08-14 22:53:45 +02:00
add preview
This commit is contained in:
parent
c58b08e47e
commit
c857a9bd76
2 changed files with 14 additions and 23 deletions
37
README.md
37
README.md
|
@ -7,6 +7,12 @@ Pangolin is a self-hosted tunneled reverse proxy management server with identity
|
|||
- [Installation Instructions](https://docs.fossorial.io)
|
||||
- [Full Documentation](https://docs.fossorial.io)
|
||||
|
||||
## Preview
|
||||
|
||||
<img src="public/screenshots/preview.png" alt="Preview"/>
|
||||
|
||||
_Sites page of Pangolin showing multiple site-to-site tunnels connected to the central server._
|
||||
|
||||
## Key Features
|
||||
|
||||
### Reverse Proxy Through WireGuard Tunnel
|
||||
|
@ -27,6 +33,12 @@ Pangolin is a self-hosted tunneled reverse proxy management server with identity
|
|||
- Resource specific pin codes.
|
||||
- Resource specific passwords.
|
||||
|
||||
### Simple Dashboard UI
|
||||
|
||||
- Manage sites, users, and roles with a clean and intuitive UI.
|
||||
- Monitor site usage and connectivity.
|
||||
- Light and dark mode options.
|
||||
|
||||
### Easy Deployment
|
||||
|
||||
- Docker Compose based setup for simplified deployment.
|
||||
|
@ -58,10 +70,12 @@ Pangolin has a straightforward and simple dashboard UI:
|
|||
<tr>
|
||||
<td align="center"><img src="public/screenshots/auth.png" alt="Authentication Example" width="200"/></td>
|
||||
<td align="center"><img src="public/screenshots/connectivity.png" alt="Connectivity Example" width="200"/></td>
|
||||
<td align="center"></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><b>Authentication</b></td>
|
||||
<td align="center"><b>Connectivity</b></td>
|
||||
<td align="center"><b></b></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
@ -101,29 +115,6 @@ Pangolin was inspired by several existing projects and concepts:
|
|||
- **Authentic and Authelia**:
|
||||
These projects inspired Pangolin’s centralized authentication system for proxies, enabling robust user and role management.
|
||||
|
||||
## Technical Setup
|
||||
|
||||
### Components Overview
|
||||
|
||||
Pangolin’s architecture consists of the following components, each designed to handle a specific aspect of the system:
|
||||
|
||||
1. **Pangolin** (Management Application & Central Server):
|
||||
The central hub for managing users, roles, organizations, and resources. Pangolin handles authentication, access control, and API management.
|
||||
|
||||
2. [**Gerbil**](https://github.com/fosrl/gerbil) (WireGuard Interface Management):
|
||||
Acts as the intermediary for managing WireGuard configurations. It creates and maintains the secure tunnels between sites and the Pangolin server.
|
||||
|
||||
3. [**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 or CrowdSec.
|
||||
- Enhanced security via our custom Traefik plugin [**Badger**](https://github.com/fosrl/badger), which acts as an authentication bouncer.
|
||||
|
||||
4. [**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 for managing endpoints.
|
||||
- Facilitates networking through its connection to Gerbil over the encrypted tunnel.
|
||||
|
||||
## Licensing
|
||||
|
||||
Pangolin is released under the ... license. For inquiries about commercial licensing, please contact us.
|
||||
|
|
BIN
public/screenshots/preview.png
Normal file
BIN
public/screenshots/preview.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 251 KiB |
Loading…
Add table
Add a link
Reference in a new issue