mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-02-07 21:46:42 +00:00
Add to docs.json and small tweaks
This commit is contained in:
Owen
429
docs.json
429
docs.json
@@ -1,216 +1,219 @@
|
||||
{
|
||||
"$schema": "https://mintlify.com/docs.json",
|
||||
"theme": "aspen",
|
||||
"name": "Pangolin Docs",
|
||||
"description": "Pangolin is a self-hosted alternative to Cloudflare Tunnels, designed to provide secure and highly-available ingress access to applications.",
|
||||
"colors": {
|
||||
"primary": "#F36117",
|
||||
"light": "#F36117",
|
||||
"dark": "#F36117"
|
||||
},
|
||||
"banner": {
|
||||
"content": "We're hiring software engineers! [Click here](https://click.fossorial.io/L0OXr) to get in touch.",
|
||||
"dismissible": true
|
||||
},
|
||||
"favicon": "/favicon.svg",
|
||||
"navigation": {
|
||||
"tabs": [
|
||||
{
|
||||
"tab": "Docs",
|
||||
"groups": [
|
||||
{
|
||||
"group": "About",
|
||||
"pages": [
|
||||
"about/how-pangolin-works",
|
||||
"about/pangolin-vs-traditional-reverse-proxy",
|
||||
"about/pangolin-vs-vpn"
|
||||
"$schema": "https://mintlify.com/docs.json",
|
||||
"theme": "aspen",
|
||||
"name": "Pangolin Docs",
|
||||
"description": "Pangolin is a self-hosted alternative to Cloudflare Tunnels, designed to provide secure and highly-available ingress access to applications.",
|
||||
"colors": {
|
||||
"primary": "#F36117",
|
||||
"light": "#F36117",
|
||||
"dark": "#F36117"
|
||||
},
|
||||
"banner": {
|
||||
"content": "We're hiring software engineers! [Click here](https://click.fossorial.io/L0OXr) to get in touch.",
|
||||
"dismissible": true
|
||||
},
|
||||
"favicon": "/favicon.svg",
|
||||
"navigation": {
|
||||
"tabs": [
|
||||
{
|
||||
"tab": "Docs",
|
||||
"groups": [
|
||||
{
|
||||
"group": "About",
|
||||
"pages": [
|
||||
"about/how-pangolin-works",
|
||||
"about/pangolin-vs-traditional-reverse-proxy",
|
||||
"about/pangolin-vs-vpn"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Pangolin",
|
||||
"pages": [
|
||||
"manage/nodes",
|
||||
"manage/managed",
|
||||
{
|
||||
"group": "Sites",
|
||||
"pages": [
|
||||
"manage/sites/add-site",
|
||||
"manage/sites/install-site",
|
||||
"manage/sites/install-kubernetes",
|
||||
"manage/sites/configure-site",
|
||||
"manage/sites/update-site"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Resources",
|
||||
"pages": [
|
||||
"manage/resources/targets",
|
||||
"manage/resources/tcp-udp-resources",
|
||||
"manage/resources/client-resources"
|
||||
]
|
||||
},
|
||||
"manage/healthchecks-failover",
|
||||
"manage/geoblocking",
|
||||
"manage/blueprints",
|
||||
{
|
||||
"group": "Clients",
|
||||
"pages": [
|
||||
"manage/clients/add-client",
|
||||
"manage/clients/install-client",
|
||||
"manage/clients/configure-client"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Access Control",
|
||||
"pages": [
|
||||
"manage/access-control/rules",
|
||||
"manage/access-control/forwarded-headers",
|
||||
"manage/access-control/login-page"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Identity Providers",
|
||||
"pages": [
|
||||
"manage/identity-providers/add-an-idp",
|
||||
"manage/identity-providers/auto-provisioning",
|
||||
"manage/identity-providers/openid-connect",
|
||||
"manage/identity-providers/google",
|
||||
"manage/identity-providers/azure",
|
||||
"manage/identity-providers/pocket-id",
|
||||
"manage/identity-providers/zitadel"
|
||||
]
|
||||
},
|
||||
"manage/domains",
|
||||
"manage/integration-api"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Self-host Managed Pangolin",
|
||||
"pages": [
|
||||
"self-host/quick-install-managed",
|
||||
{
|
||||
"group": "Manual Installation",
|
||||
"pages": [
|
||||
"self-host/manual/managed"
|
||||
]
|
||||
},
|
||||
"self-host/choosing-a-vps",
|
||||
"self-host/how-to-update"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Community Edition",
|
||||
"pages": [
|
||||
"self-host/quick-install",
|
||||
{
|
||||
"group": "Manual Installation",
|
||||
"pages": [
|
||||
"self-host/manual/docker-compose",
|
||||
"self-host/manual/unraid"
|
||||
]
|
||||
},
|
||||
"self-host/dns-and-networking",
|
||||
"self-host/convert-managed",
|
||||
"self-host/supporter-program",
|
||||
"self-host/system-architecture",
|
||||
{
|
||||
"group": "Advanced Configuration",
|
||||
"pages": [
|
||||
"self-host/advanced/config-file",
|
||||
"self-host/advanced/wild-card-domains",
|
||||
"self-host/advanced/cloudflare-proxy",
|
||||
"self-host/advanced/without-tunneling",
|
||||
"self-host/advanced/container-cli-tool",
|
||||
"self-host/advanced/database-options",
|
||||
"self-host/advanced/integration-api"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Community Guides",
|
||||
"pages": [
|
||||
"self-host/community-guides/overview",
|
||||
"self-host/community-guides/proxyprotocol",
|
||||
"self-host/community-guides/geoblock",
|
||||
"self-host/community-guides/crowdsec",
|
||||
"self-host/community-guides/metrics",
|
||||
"self-host/community-guides/homeassistant",
|
||||
"self-host/community-guides/middlewaremanager",
|
||||
"self-host/community-guides/traefiklogsdashboard"
|
||||
]
|
||||
},
|
||||
"self-host/telemetry"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Development",
|
||||
"pages": [
|
||||
"development/contributing",
|
||||
"development/feature-requests-and-bug-reports"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Blog",
|
||||
"href": "https://digpangolin.com/blog"
|
||||
}
|
||||
],
|
||||
"global": {
|
||||
"anchors": [
|
||||
{
|
||||
"anchor": "GitHub",
|
||||
"href": "https://github.com/fosrl/pangolin",
|
||||
"icon": "github"
|
||||
},
|
||||
{
|
||||
"anchor": "Slack",
|
||||
"href": "https://digpangolin.com/slack",
|
||||
"icon": "slack"
|
||||
},
|
||||
{
|
||||
"anchor": "Discord",
|
||||
"href": "https://digpangolin.com/discord",
|
||||
"icon": "discord"
|
||||
},
|
||||
{
|
||||
"anchor": "Support Plans",
|
||||
"href": "https://digpangolin.com/support",
|
||||
"icon": "life-ring"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Pangolin",
|
||||
"pages": [
|
||||
"manage/nodes",
|
||||
"manage/managed",
|
||||
{
|
||||
"group": "Sites",
|
||||
"pages": [
|
||||
"manage/sites/add-site",
|
||||
"manage/sites/install-site",
|
||||
"manage/sites/install-kubernetes",
|
||||
"manage/sites/configure-site",
|
||||
"manage/sites/update-site"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Resources",
|
||||
"pages": [
|
||||
"manage/resources/targets",
|
||||
"manage/resources/tcp-udp-resources",
|
||||
"manage/resources/client-resources"
|
||||
]
|
||||
},
|
||||
"manage/healthchecks-failover",
|
||||
"manage/geoblocking",
|
||||
"manage/blueprints",
|
||||
{
|
||||
"group": "Clients",
|
||||
"pages": [
|
||||
"manage/clients/add-client",
|
||||
"manage/clients/install-client",
|
||||
"manage/clients/configure-client"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Access Control",
|
||||
"pages": [
|
||||
"manage/access-control/rules",
|
||||
"manage/access-control/forwarded-headers",
|
||||
"manage/access-control/login-page"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Identity Providers",
|
||||
"pages": [
|
||||
"manage/identity-providers/add-an-idp",
|
||||
"manage/identity-providers/auto-provisioning",
|
||||
"manage/identity-providers/openid-connect",
|
||||
"manage/identity-providers/google",
|
||||
"manage/identity-providers/azure",
|
||||
"manage/identity-providers/pocket-id",
|
||||
"manage/identity-providers/zitadel"
|
||||
]
|
||||
},
|
||||
"manage/domains",
|
||||
"manage/integration-api"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Self-host Managed Pangolin",
|
||||
"pages": [
|
||||
"self-host/quick-install-managed",
|
||||
{
|
||||
"group": "Manual Installation",
|
||||
"pages": ["self-host/manual/managed"]
|
||||
},
|
||||
"self-host/choosing-a-vps",
|
||||
"self-host/how-to-update"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Community Edition",
|
||||
"pages": [
|
||||
"self-host/quick-install",
|
||||
{
|
||||
"group": "Manual Installation",
|
||||
"pages": [
|
||||
"self-host/manual/docker-compose",
|
||||
"self-host/manual/unraid"
|
||||
]
|
||||
},
|
||||
"self-host/dns-and-networking",
|
||||
"self-host/convert-managed",
|
||||
"self-host/supporter-program",
|
||||
"self-host/system-architecture",
|
||||
{
|
||||
"group": "Advanced Configuration",
|
||||
"pages": [
|
||||
"self-host/advanced/config-file",
|
||||
"self-host/advanced/wild-card-domains",
|
||||
"self-host/advanced/cloudflare-proxy",
|
||||
"self-host/advanced/without-tunneling",
|
||||
"self-host/advanced/container-cli-tool",
|
||||
"self-host/advanced/database-options",
|
||||
"self-host/advanced/integration-api"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Community Guides",
|
||||
"pages": [
|
||||
"self-host/community-guides/overview",
|
||||
"self-host/community-guides/geoblock",
|
||||
"self-host/community-guides/crowdsec",
|
||||
"self-host/community-guides/metrics",
|
||||
"self-host/community-guides/homeassistant",
|
||||
"self-host/community-guides/middlewaremanager",
|
||||
"self-host/community-guides/traefiklogsdashboard"
|
||||
]
|
||||
},
|
||||
"self-host/telemetry"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Development",
|
||||
"pages": [
|
||||
"development/contributing",
|
||||
"development/feature-requests-and-bug-reports"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Blog",
|
||||
"href": "https://digpangolin.com/blog"
|
||||
}
|
||||
],
|
||||
"global": {
|
||||
"anchors": [
|
||||
{
|
||||
"anchor": "GitHub",
|
||||
"href": "https://github.com/fosrl/pangolin",
|
||||
"icon": "github"
|
||||
},
|
||||
{
|
||||
"anchor": "Slack",
|
||||
"href": "https://digpangolin.com/slack",
|
||||
"icon": "slack"
|
||||
},
|
||||
{
|
||||
"anchor": "Discord",
|
||||
"href": "https://digpangolin.com/discord",
|
||||
"icon": "discord"
|
||||
},
|
||||
{
|
||||
"anchor": "Support Plans",
|
||||
"href": "https://digpangolin.com/support",
|
||||
"icon": "life-ring"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"logo": {
|
||||
"light": "/logo/light.png",
|
||||
"dark": "/logo/dark.png",
|
||||
"href": "https://docs.digpangolin.com"
|
||||
},
|
||||
"navbar": {
|
||||
"links": [
|
||||
{
|
||||
"label": "Contact Us",
|
||||
"href": "mailto:numbat@fossorial.io"
|
||||
}
|
||||
],
|
||||
"primary": {
|
||||
"type": "button",
|
||||
"label": "Pangolin Dashboard",
|
||||
"href": "https://pangolin.fossorial.io"
|
||||
}
|
||||
},
|
||||
"footer": {
|
||||
"socials": {
|
||||
"github": "https://github.com/fosrl/pangolin",
|
||||
"linkedin": "https://linkedin.com/company/digpangolin"
|
||||
}
|
||||
},
|
||||
"integrations": {
|
||||
"posthog": {
|
||||
"apiKey": "phc_RIHQ7o2Y2hf8qms2nP62vpoJHEvsrw6TieflQGQO7yI",
|
||||
"apiHost": "https://digpangolin.com/relay-O7yI"
|
||||
}
|
||||
},
|
||||
"redirects": [
|
||||
{
|
||||
"source": "/telemetry",
|
||||
"destination": "/self-host/telemetry"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"logo": {
|
||||
"light": "/logo/light.png",
|
||||
"dark": "/logo/dark.png",
|
||||
"href": "https://docs.digpangolin.com"
|
||||
},
|
||||
"navbar": {
|
||||
"links": [
|
||||
{
|
||||
"label": "Contact Us",
|
||||
"href": "mailto:numbat@fossorial.io"
|
||||
}
|
||||
],
|
||||
"primary": {
|
||||
"type": "button",
|
||||
"label": "Pangolin Dashboard",
|
||||
"href": "https://pangolin.fossorial.io"
|
||||
}
|
||||
},
|
||||
"footer": {
|
||||
"socials": {
|
||||
"github": "https://github.com/fosrl/pangolin",
|
||||
"linkedin": "https://linkedin.com/company/digpangolin"
|
||||
}
|
||||
},
|
||||
"integrations": {
|
||||
"posthog": {
|
||||
"apiKey": "phc_RIHQ7o2Y2hf8qms2nP62vpoJHEvsrw6TieflQGQO7yI",
|
||||
"apiHost": "https://digpangolin.com/relay-O7yI"
|
||||
}
|
||||
},
|
||||
"redirects": [
|
||||
{
|
||||
"source": "/telemetry",
|
||||
"destination": "/self-host/telemetry"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Proxy Protocol (Advanced)"
|
||||
title: "Proxy Protocol"
|
||||
description: "Using Proxy Protocol to Preserve Client IPs for TCP/UDP backends"
|
||||
---
|
||||
|
||||
@@ -92,7 +92,7 @@ Follow this down further until you reach the service line — `43-service` in th
|
||||
},
|
||||
```
|
||||
|
||||
Make a note of the address there.
|
||||
Make a note of the address there. Keep in mind that _this address will change if you update the site on the target or change information about the target like the port or IP address or delete the target._
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user