mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-03-10 20:56:46 +00:00
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "How Pangolin Works"
|
||||
icon: "brain"
|
||||
description: "Learn about the fundamentals of Pangolin and how they work together to provide simple and secure remote access."
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "Pangolin vs. Reverse Proxy vs. VPN"
|
||||
icon: "book"
|
||||
title: "Pangolin vs. Proxy vs. VPN"
|
||||
description: "What are the similarities and differences between Pangolin and traditional reverse proxies and VPNs?"
|
||||
---
|
||||
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
title: "Changelog"
|
||||
icon: "clipboard-list"
|
||||
---
|
||||
|
||||
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
|
||||
<PangolinCloudTocCta />
|
||||
|
||||
|
||||
|
||||
To view the complete changelog, please visit our [GitHub Releases
|
||||
page](https://github.com/fosrl/pangolin/releases).
|
||||
@@ -1,12 +0,0 @@
|
||||
---
|
||||
title: "Trust Center"
|
||||
icon: "scale-balanced"
|
||||
---
|
||||
|
||||
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
|
||||
<PangolinCloudTocCta />
|
||||
|
||||
<Card title="Visit our trust center" icon="shield" href="https://trust.pangolin.net">
|
||||
Visit our trust center for more information on frameworks, polices, and licenses.
|
||||
</Card>
|
||||
160
docs.json
160
docs.json
@@ -1,18 +1,26 @@
|
||||
{
|
||||
"$schema": "https://mintlify.com/docs.json",
|
||||
"theme": "aspen",
|
||||
"theme": "mint",
|
||||
"name": "Pangolin Docs",
|
||||
"description": "Pangolin is the easiest to use identity-based remote access platform based on WireGuard.",
|
||||
"description": "Zero trust access to all your infrastructure, self-hosted applications, and SaaS tools. Easy to deploy and scale. Better than your existing VPN.",
|
||||
"colors": {
|
||||
"primary": "#F36117",
|
||||
"light": "#F36117",
|
||||
"primary": "#202020",
|
||||
"light": "#202020",
|
||||
"dark": "#F36117"
|
||||
},
|
||||
"favicon": "/favicon.svg",
|
||||
"background": {
|
||||
"color": {
|
||||
"light": "#FAF9F2"
|
||||
}
|
||||
},
|
||||
"styling": {
|
||||
"codeblocks": "dark"
|
||||
},
|
||||
"favicon": "/favicon.png",
|
||||
"navigation": {
|
||||
"tabs": [
|
||||
{
|
||||
"tab": "Docs",
|
||||
"tab": "Documentation",
|
||||
"groups": [
|
||||
{
|
||||
"group": "About",
|
||||
@@ -186,13 +194,6 @@
|
||||
"self-host/supporter-program"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Careers",
|
||||
"pages": [
|
||||
"careers/join-us",
|
||||
"careers/software-engineer-full-stack"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Development",
|
||||
"pages": [
|
||||
@@ -200,48 +201,38 @@
|
||||
"development/contributing",
|
||||
"development/feature-requests-and-bug-reports"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Additional Resources",
|
||||
"pages": [
|
||||
"additional-resources/changelog",
|
||||
"additional-resources/trust-center"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Blog",
|
||||
"href": "https://pangolin.net/blog"
|
||||
"tab": "Guides",
|
||||
"href": "https://pangolin.net/news"
|
||||
},
|
||||
{
|
||||
"tab": "Downloads",
|
||||
"href": "https://pangolin.net/downloads"
|
||||
},
|
||||
{
|
||||
"tab": "Website",
|
||||
"href": "https://pangolin.net/"
|
||||
},
|
||||
{
|
||||
"tab": "Careers",
|
||||
"href": "https://pangolin.net/careers"
|
||||
},
|
||||
{
|
||||
"tab": "Trust Center",
|
||||
"href": "https://trust.pangolin.net/"
|
||||
}
|
||||
],
|
||||
"global": {
|
||||
"anchors": [
|
||||
{
|
||||
"anchor": "GitHub",
|
||||
"href": "https://github.com/fosrl/pangolin",
|
||||
"icon": "github"
|
||||
},
|
||||
{
|
||||
"anchor": "Slack",
|
||||
"href": "https://pangolin.net/slack",
|
||||
"icon": "slack"
|
||||
},
|
||||
{
|
||||
"anchor": "Discord",
|
||||
"href": "https://pangolin.net/discord",
|
||||
"icon": "discord"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"interaction": {
|
||||
"drilldown": true
|
||||
},
|
||||
"appearance": {
|
||||
"default": "light",
|
||||
"strict": true
|
||||
},
|
||||
"logo": {
|
||||
"light": "/logo/light.png",
|
||||
"dark": "/logo/dark.png",
|
||||
@@ -250,26 +241,93 @@
|
||||
"navbar": {
|
||||
"links": [
|
||||
{
|
||||
"label": "Log In",
|
||||
"label": "Log in",
|
||||
"href": "https://app.pangolin.net/auth/login"
|
||||
},
|
||||
{
|
||||
"label": "Contact Us",
|
||||
"icon": "envelope",
|
||||
"href": "mailto:contact@pangolin.net"
|
||||
}
|
||||
],
|
||||
"primary": {
|
||||
"type": "button",
|
||||
"label": "Pangolin Dashboard",
|
||||
"label": "Start for free",
|
||||
"href": "https://app.pangolin.net/auth/signup"
|
||||
}
|
||||
},
|
||||
"footer": {
|
||||
"socials": {
|
||||
"slack": "https://pangolin.net/slack",
|
||||
"github": "https://github.com/fosrl/pangolin",
|
||||
"linkedin": "https://linkedin.com/company/digpangolin"
|
||||
}
|
||||
"linkedin": "https://linkedin.com/company/digpangolin",
|
||||
"youtube": "https://youtube.com/@pangolin"
|
||||
},
|
||||
"links": [
|
||||
{
|
||||
"header": "Product",
|
||||
"items": [
|
||||
{
|
||||
"label": "Documentation",
|
||||
"href": "https://docs.pangolin.net"
|
||||
},
|
||||
{
|
||||
"label": "Downloads",
|
||||
"href": "https://app.pangolin.net/auth/signup"
|
||||
},
|
||||
{
|
||||
"label": "Status",
|
||||
"href": "https://status.pangolin.net"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"header": "Company",
|
||||
"items": [
|
||||
{
|
||||
"label": "Careers",
|
||||
"href": "https://docs.pangolin.net/careers/join-us"
|
||||
},
|
||||
{
|
||||
"label": "Contact",
|
||||
"href": "mailto:contact@pangolin.net"
|
||||
},
|
||||
{
|
||||
"label": "News & Articles",
|
||||
"href": "https://pangolin.net/news"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"header": "Legal",
|
||||
"items": [
|
||||
{
|
||||
"label": "Trust Center",
|
||||
"href": "https://trust.pangolin.net/"
|
||||
},
|
||||
{
|
||||
"label": "Privacy",
|
||||
"href": "https://pangolin.net/privacy-policy.html"
|
||||
},
|
||||
{
|
||||
"label": "Terms",
|
||||
"href": "https://pangolin.net/terms-of-service.html"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"header": "Follow",
|
||||
"items": [
|
||||
{
|
||||
"label": "GitHub",
|
||||
"href": "https://github.com/fosrl/pangolin"
|
||||
},
|
||||
{
|
||||
"label": "LinkedIn",
|
||||
"href": "https://linkedin.com/company/pangolin-net"
|
||||
},
|
||||
{
|
||||
"label": "YouTube",
|
||||
"href": "https://youtube.com/@pangolin"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"integrations": {
|
||||
"posthog": {
|
||||
|
||||
BIN
favicon.png
Normal file
BIN
favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 816 B |
22
favicon.svg
22
favicon.svg
@@ -1,22 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||
|
||||
<svg
|
||||
width="900.82861"
|
||||
height="955.20648"
|
||||
viewBox="0 0 238.34422 252.7317"
|
||||
version="1.1"
|
||||
id="svg420"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:svg="http://www.w3.org/2000/svg">
|
||||
<defs
|
||||
id="defs417" />
|
||||
<g
|
||||
id="layer1"
|
||||
transform="translate(-13.119542,-5.9258171)">
|
||||
<path
|
||||
d="m 213.66176,90.072122 c 4.95655,0 8.97383,4.018046 8.97383,8.973827 0,4.956581 -4.01728,8.974621 -8.97383,8.974621 -4.95657,0 -8.97462,-4.01804 -8.97462,-8.974621 0,-4.955781 4.01805,-8.973827 8.97462,-8.973827 z m 35.2316,37.450998 c -0.90048,29.80928 -23.66033,69.21262 -54.51292,79.34466 -36.04206,11.836 -63.40991,-5.92226 -72.08409,-26.74061 -6.75754,-16.21966 -1.65117,-35.62363 10.96266,-43.83669 10.6506,-6.93533 30.48543,-8.76736 47.15454,2.19144 -5.85627,-15.34246 -21.62491,-25.4256 -35.59101,-28.49424 -13.96613,-3.06867 -28.38324,0.43858 -38.74504,5.69946 13.29071,-14.68572 44.40801,-28.946049 78.24077,-10.95958 22.67676,12.05491 32.43775,28.93208 42.0489,51.72763 C 251.59637,117.87858 234.026,71.411066 203.39074,43.794029 172.15544,15.636686 129.95516,4.340214 97.668803,6.103155 108.32483,12.678273 120.84625,22.06586 132.41209,33.053363 81.298533,26.697169 39.174705,38.314245 13.119542,73.749217 27.67508,70.878527 46.868833,69.073666 65.974711,70.016861 28.737658,96.252107 7.1124298,140.38147 18.105298,186.43137 c 6.718497,-11.74129 16.767711,-25.84558 28.726275,-38.62863 -3.677175,34.36994 1.42836,80.83745 45.62293,110.85478 -2.25587,-9.42394 -4.08014,-20.88443 -4.91466,-33.0154 20.673197,16.1282 50.685067,29.42205 87.917917,20.24096 65.77679,-16.21975 83.34719,-79.78335 73.4356,-118.35996"
|
||||
style="fill:#f36118;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.0776283"
|
||||
id="path32" />
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.8 KiB |
BIN
logo/light.png
BIN
logo/light.png
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 9.4 KiB |
@@ -15,15 +15,6 @@ Custom auth pages are only available in [Pangolin Cloud](https://app.pangolin.ne
|
||||
|
||||
Custom organization authentication pages let you serve the login page at your own domain instead of the default `app.pangolin.net`. This provides better user experience and brand consistency.
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/fD-NpigE4Vw?si=M5BBiqoKRWSZNGU1"
|
||||
title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Benefits
|
||||
|
||||
**For Resource Authentication:**
|
||||
|
||||
@@ -12,15 +12,6 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
|
||||
Blueprints provide a way to define your Pangolin resources and their configurations in a structured, declarative format. This allows for easier management, version control, and automation of your resource setups.
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/lMauwwitSAE?si=k9-TUoandoffMrzV"
|
||||
title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Overview
|
||||
|
||||
Pangolin supports two blueprint formats:
|
||||
|
||||
@@ -13,15 +13,6 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
Geoblocking is available in Pangolin community! Make sure to follow this guide for how to enable: [Enabling Geo Blocking](/self-host/advanced/enable-geoblocking)
|
||||
</Note>
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/_2EheKVUYxI"
|
||||
title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Benefits of Geo Blocking
|
||||
|
||||
Geo blocking provides several important security and compliance advantages:
|
||||
|
||||
@@ -13,15 +13,6 @@ Identity providers allow your users to log into Pangolin and Pangolin resources
|
||||
|
||||
Here is an example using Microsoft Azure Entra ID as SSO for Pangolin:
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl mb-10"
|
||||
src="https://www.youtube.com/embed/41OWI8uHPZg?si=VYGGAerzsIDe6wUx"
|
||||
title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
**This feature is for you if:**
|
||||
- Your organization already uses an identity provider like Google Workspace, Microsoft Entra ID, Okta, or similar systems
|
||||
- You want to centralize user management and avoid maintaining separate Pangolin accounts
|
||||
|
||||
@@ -15,15 +15,6 @@ Azure SSO is only available on [Pangolin Cloud](https://app.pangolin.net/auth/si
|
||||
|
||||
The following steps will integrate Microsoft SSO using the built in Azure Entra ID identity provider in Pangolin.
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl mb-10"
|
||||
src="https://www.youtube.com/embed/41OWI8uHPZg?si=VYGGAerzsIDe6wUx"
|
||||
title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
<Accordion title="How to create and set up an App Registration in Microsoft Azure from scratch">
|
||||
|
||||
#### Create an App Registration
|
||||
|
||||
@@ -15,16 +15,6 @@ Google SSO is only available on [Pangolin Cloud](https://app.pangolin.net/auth/s
|
||||
|
||||
The following steps will integrate Google SSO using the built in Google identity provider in Pangolin.
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl mb-10"
|
||||
src="https://www.youtube.com/embed/Xh4sl-9wK2I?si=hQvKusR-YPzGnP73"
|
||||
title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
|
||||
<Accordion title="How to create and set up a Google Project from scratch">
|
||||
|
||||
[Create a new Project](https://console.cloud.google.com/projectcreate), or use an [existing Project](https://console.developers.google.com/) you've already created in the Google Developers Console. Setting the organization isn't required, unless you intend to use SSO for [more than 100 users](https://support.google.com/cloud/answer/13464323) externally (not via Google Workspace).
|
||||
|
||||
@@ -9,15 +9,6 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
|
||||
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/iPdK8M0cb9s"
|
||||
title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, ensure you have:
|
||||
|
||||
@@ -7,7 +7,7 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
|
||||
<PangolinCloudTocCta />
|
||||
|
||||
<Card title="Get a License" icon="server" href="https://pangolin.net/pricing?hosting=self-host">
|
||||
<Card title="Get a License" icon="server" href="https://pangolin.net/pricing">
|
||||
Get a license for Pangolin Enterprise Edition.
|
||||
</Card>
|
||||
|
||||
@@ -58,7 +58,7 @@ The Enterprise Edition is distributed under the **Fossorial Commercial License**
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
To see pricing tiers for the self-hosted Enterprise Edition for businesses, [click here](https://pangolin.net/pricing?hosting=self-host). For more on how to purchase a key, see [Purchase a license key](/self-host/purchase-license-key).
|
||||
To see pricing tiers for the self-hosted Enterprise Edition for businesses, [click here](https://pangolin.net/pricing). For more on how to purchase a key, see [Purchase a license key](/self-host/purchase-license-key).
|
||||
|
||||
## Getting Your License Key
|
||||
|
||||
|
||||
@@ -10,15 +10,6 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
|
||||
|
||||
|
||||
<iframe
|
||||
className="w-full aspect-video rounded-xl"
|
||||
src="https://www.youtube.com/embed/0upWrqkJPy8?si=q0D-uR1IHuddaqeT"
|
||||
title="Pangolin Quick Install Guide"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, ensure you have:
|
||||
|
||||
@@ -12,7 +12,7 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
Pangolin self-hosted will always be free and open source, but maintaining the project takes time and resources. The supporter program helps fund ongoing development — including bug fixes, new features, and community support.
|
||||
|
||||
<Note>
|
||||
**Business & Enterprise Users:** For larger organizations or teams requiring advanced features, consider our self-serve enterprise license and [Enterprise Edition](/self-host/enterprise-edition). [Learn more](https://pangolin.net/pricing?hosting=self-host)
|
||||
**Business & Enterprise Users:** For larger organizations or teams requiring advanced features, consider our self-serve enterprise license and [Enterprise Edition](/self-host/enterprise-edition). [Learn more](https://pangolin.net/pricing)
|
||||
</Note>
|
||||
|
||||
## Supporter Tiers
|
||||
|
||||
97
style.css
97
style.css
@@ -6,4 +6,101 @@
|
||||
/* Space above the Pangolin Cloud CTA (below the table of contents links) */
|
||||
#table-of-contents > *:last-child {
|
||||
margin-top: 1.25rem;
|
||||
background-color: #F2F0E7;
|
||||
}
|
||||
|
||||
#navbar .max-w-8xl {
|
||||
max-width: 100%;
|
||||
background-color: #F2F0E7;
|
||||
border-bottom: 1px solid #E8E7E5;
|
||||
}
|
||||
|
||||
/* No border between search row and tab links */
|
||||
#navbar .border-b {
|
||||
border-bottom: none !important;
|
||||
}
|
||||
|
||||
#sidebar {
|
||||
left: 0;
|
||||
padding-right: 30px;
|
||||
background-color: #F2F0E7;
|
||||
}
|
||||
|
||||
#sidebar-content {
|
||||
padding-left: 2rem;
|
||||
}
|
||||
|
||||
#sidebar-content ul.sidebar-group {
|
||||
gap: 0;
|
||||
}
|
||||
|
||||
#sidebar-content ul.sidebar-group li {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
#sidebar .relative .sticky {
|
||||
opacity: 0;
|
||||
}
|
||||
|
||||
#header {
|
||||
padding-bottom: 25px;
|
||||
padding-top: 25px;
|
||||
border-bottom: 1px solid #E8E7E5;
|
||||
margin-bottom: 50px;
|
||||
}
|
||||
|
||||
#content-area .mt-8 .block {
|
||||
background-color: #F2F0E7;
|
||||
border: none !important;
|
||||
}
|
||||
|
||||
/* No borders on cards */
|
||||
[class*="card"],
|
||||
[class*="Card"],
|
||||
#table-of-contents > *:last-child {
|
||||
border: none !important;
|
||||
}
|
||||
|
||||
/* Step number circle: match card background */
|
||||
[data-component-part="step-number"] .rounded-full,
|
||||
[data-component-part="step-number"] .bg-gray-50,
|
||||
[data-component-part="step-number"] .dark\:bg-white\/10 {
|
||||
background-color: #F2F0E7 !important;
|
||||
}
|
||||
|
||||
#topbar-cta-button .group .flex {
|
||||
margin-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
/* Fully rounded (pill) buttons */
|
||||
#navbar .links a,
|
||||
#topbar-cta-button .group .absolute,
|
||||
#topbar-cta-button a {
|
||||
border-radius: 9999px !important;
|
||||
}
|
||||
|
||||
/* CTA button background (navbar + footer) */
|
||||
#topbar-cta-button .group .absolute,
|
||||
#topbar-cta-button a {
|
||||
background-color: #202020 !important;
|
||||
}
|
||||
|
||||
#footer {
|
||||
background-color: #F2F0E7;
|
||||
border-color: #E8E7E5 !important;
|
||||
}
|
||||
|
||||
#footer .border-t {
|
||||
border-color: #E8E7E5 !important;
|
||||
}
|
||||
|
||||
#footer .bg-gray-100,
|
||||
#footer .dark\:bg-white\/5 {
|
||||
background-color: #E8E7E5 !important;
|
||||
}
|
||||
|
||||
/* Remove the divider line above "Powered by" */
|
||||
#footer div[class*="1px"] {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user