diff --git a/packages/docusaurus/docs/03-Pangolin/06-bypass-rules.md b/packages/docusaurus/docs/03-Pangolin/06-bypass-rules.md index f9b2d1b..3c0b747 100644 --- a/packages/docusaurus/docs/03-Pangolin/06-bypass-rules.md +++ b/packages/docusaurus/docs/03-Pangolin/06-bypass-rules.md @@ -9,30 +9,30 @@ This table compiles paths that need to be allowed for various apps to work with | App | Required Bypass Rules | |-----|------------------------| | **Media Management** | | -| Radarr | `/api/\*` | -| Sonarr | `/api/\*` | -| Lidarr | `/api/\*` | +| Radarr | `/api/*` | +| Sonarr | `/api/*` | +| Lidarr | `/api/*` | | Jellyfin (iOS) | `/system/info/public` | | Jellyfin (Roku) | `/System/Info/Public`
`/Users/AuthenticateByName`
`/Users/Public`
`/QuickConnect/Initiate`
`/QuickConnect/Connect`
`/Users/AuthenticateWithQuickConnect` | | **Management & Monitoring** | | -| Tautulli | `/api/\*` | -| Harbour | `/api/\*` | -| Hoarder App | `/api/\*` | -| Uptime Kuma Manager | `/api/\*`
`/socket.io/\*` | -| MeshCentral | `/api/\*`
`/meshrelay.ashx`
`/agent.ashx` | +| Tautulli | `/api/*` | +| Harbour | `/api/*` | +| Hoarder App | `/api/*` | +| Uptime Kuma Manager | `/api/*`
`/socket.io/*` | +| MeshCentral | `/api/*`
`/meshrelay.ashx`
`/agent.ashx` | | **Security & Privacy** | | -| AdGuard Home | `/api/\*` | -| Vaultwarden/Bitwarden | `/api/\*`
`/identity/\*`
`/wl/\*`
Always Deny - Path - `/admin/\*` | +| AdGuard Home | `/api/*` | +| Vaultwarden/Bitwarden | `/api/*`
`/identity/*`
`/wl/*`
Always Deny - Path - `/admin/*` | | **Cloud & Sync** | | -| Nextcloud | `/` (Main interface)
`/index.php` (Core handler)
`/remote.php` (Remote access)
`/status.php` (Status checks)
`/ocs` (Collaboration Services API)
`/apps` (Applications)
`/remote.php/webdav` (WebDAV endpoint)
`/remote.php/dav` (CalDAV/CardDAV)
`/remote.php/caldav` (Calendar sync)
`/remote.php/carddav` (Contacts sync)
`/ocs/v1.php` (API endpoints)
`/ocs/v2.php` (API v2 endpoints)
`/login` (Authentication)
`/.well-known/\*` (Service discovery)
`/.well-known/webfinger` (WebFinger protocol)
`/s/\*` (Shared files/folders) | +| Nextcloud | `/` (Main interface)
`/index.php` (Core handler)
`/remote.php` (Remote access)
`/status.php` (Status checks)
`/ocs` (Collaboration Services API)
`/apps` (Applications)
`/remote.php/webdav` (WebDAV endpoint)
`/remote.php/dav` (CalDAV/CardDAV)
`/remote.php/caldav` (Calendar sync)
`/remote.php/carddav` (Contacts sync)
`/ocs/v1.php` (API endpoints)
`/ocs/v2.php` (API v2 endpoints)
`/login` (Authentication)
`/.well-known/*` (Service discovery)
`/.well-known/webfinger` (WebFinger protocol)
`/s/*` (Shared files/folders) | | **Photo Management** | | -| Immich | `/api/\*`
`/.well-known/immich` | +| Immich | `/api/*`
`/.well-known/immich` | | **Notes & Knowledge Management** | | -| Joplin Notes Server | `/api/\*`
`/shares/\*`
`/css/\*`
`/images/\*`
Always Deny - Path - `/login/\*` (optional) | -| Erugo | `/api/\*`
`/shares/\*`
`/build/\*`
`/get-logo` | +| Joplin Notes Server | `/api/*`
`/shares/*`
`/css/*`
`/images/*`
Always Deny - Path - `/login/*` (optional) | +| Erugo | `/api/*`
`/shares/*`
`/build/*`
`/get-logo` | | **Communication** | | -| Matrix/Synapse (Clients) | `/_matrix/\*`
`/_synapse/client/\*` | -| Matrix/Synapse (Federation) | `/_matrix/\*` | +| Matrix/Synapse (Clients) | `/_matrix/*`
`/_synapse/client/*` | +| Matrix/Synapse (Federation) | `/_matrix/*` | | **Notifications** | | | Gotify | `/version`
`/message`
`/application`
`/client`
`/stream`
`/plugin`
`/health` | @@ -47,11 +47,11 @@ Right now you can match on the following items: Path match rules allow you to specify URL patterns using simple text and wildcards. A valid pattern can include regular path segments, slashes, and wildcards (\*) which match any characters. Examples: -- blog/posts - Matches exact path -- blog/\* - Matches all paths under blog -- \*/2023/\* - Matches any path with 2023 as a middle segment -- product\* - Matches paths starting with "product" -- \*admin\* - Matches any path containing "admin" +- `blog/posts` - Matches exact path +- `blog/*` - Matches all paths under blog +- `*/2023/*` - Matches any path with 2023 as a middle segment +- `product*` - Matches paths starting with "product" +- `*admin*` - Matches any path containing "admin" Wildcards can appear anywhere in a segment, and special characters like dashes, underscores, and common punctuation are allowed. Avoid empty segments, double slashes, and non-URL characters. @@ -60,10 +60,10 @@ Wildcards can appear anywhere in a segment, and special characters like dashes, CIDR (Classless Inter-Domain Routing) notation specifies IP address ranges using an IP address and a network prefix length. The format is [IP address]/[prefix length]. Examples: -- 144.234.11.22/24 - Matches all 256 IPs from 192.168.1.0 to 192.168.1.255 -- 10.0.0.0/8 - Matches any IP starting with 10 (16.7 million addresses) -- 2001:db8::/32 - Matches a range of IPv6 addresses -- 0.0.0.0/0 - Matches all IPv4 addresses +- `144.234.11.22/24` - Matches all 256 IPs from 192.168.1.0 to 192.168.1.255 +- `10.0.0.0/8` - Matches any IP starting with 10 (16.7 million addresses) +- `2001:db8::/32` - Matches a range of IPv6 addresses +- `0.0.0.0/0` - Matches all IPv4 addresses The prefix length (1-32 for IPv4, 1-128 for IPv6) determines how many bits from the left are fixed. Smaller prefix numbers match larger ranges. Valid CIDR notation requires a properly formatted IP address followed by a slash and a valid prefix length. @@ -72,6 +72,6 @@ The prefix length (1-32 for IPv4, 1-128 for IPv6) determines how many bits from Pretty simple: you can match on simply a IP address like your home IP to bypass auth. This is the same as entering a /32 CIDR. Examples: -- 23.234.134.32 -- 34.45.245.64 -- 100.11.243.169 \ No newline at end of file +- `23.234.134.32` +- `34.45.245.64` +- `192.168.1.1` \ No newline at end of file