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

Fix \* issues

Browse source
This commit is contained in:
Owen 2025-03-24 10:37:53 -04:00
parent d51f378ca3
commit 4693ab1ec9
No known key found for this signature in database
GPG key ID: 8271FDFFD9E0CCBD
1 changed files with 28 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
packages/docusaurus/docs/03-Pangolin/06-bypass-rules.md
View file

@ -9,30 +9,30 @@ This table compiles paths that need to be allowed for various apps to work with
| App | Required Bypass Rules | | App | Required Bypass Rules |
|-----|------------------------| |-----|------------------------|
| **Media Management** | | | **Media Management** | |
| Radarr | `/api/\*` | | Radarr | `/api/*` |
| Sonarr | `/api/\*` | | Sonarr | `/api/*` |
| Lidarr | `/api/\*` | | Lidarr | `/api/*` |
| Jellyfin (iOS) | `/system/info/public` | | Jellyfin (iOS) | `/system/info/public` |
| Jellyfin (Roku) | `/System/Info/Public`<br />`/Users/AuthenticateByName`<br />`/Users/Public`<br />`/QuickConnect/Initiate`<br />`/QuickConnect/Connect`<br />`/Users/AuthenticateWithQuickConnect` | | Jellyfin (Roku) | `/System/Info/Public`<br />`/Users/AuthenticateByName`<br />`/Users/Public`<br />`/QuickConnect/Initiate`<br />`/QuickConnect/Connect`<br />`/Users/AuthenticateWithQuickConnect` |
| **Management & Monitoring** | | | **Management & Monitoring** | |
| Tautulli | `/api/\*` | | Tautulli | `/api/*` |
| Harbour | `/api/\*` | | Harbour | `/api/*` |
| Hoarder App | `/api/\*` | | Hoarder App | `/api/*` |
| Uptime Kuma Manager | `/api/\*`<br />`/socket.io/\*` | | Uptime Kuma Manager | `/api/*`<br />`/socket.io/*` |
| MeshCentral | `/api/\*`<br />`/meshrelay.ashx`<br />`/agent.ashx` | | MeshCentral | `/api/*`<br />`/meshrelay.ashx`<br />`/agent.ashx` |
| **Security & Privacy** | | | **Security & Privacy** | |
| AdGuard Home | `/api/\*` | | AdGuard Home | `/api/*` |
| Vaultwarden/Bitwarden | `/api/\*`<br />`/identity/\*`<br />`/wl/\*`<br />Always Deny - Path - `/admin/\*` | | Vaultwarden/Bitwarden | `/api/*`<br />`/identity/*`<br />`/wl/*`<br />Always Deny - Path - `/admin/*` |
| **Cloud & Sync** | | | **Cloud & Sync** | |
| Nextcloud | `/` (Main interface)<br />`/index.php` (Core handler)<br />`/remote.php` (Remote access)<br />`/status.php` (Status checks)<br />`/ocs` (Collaboration Services API)<br />`/apps` (Applications)<br />`/remote.php/webdav` (WebDAV endpoint)<br />`/remote.php/dav` (CalDAV/CardDAV)<br />`/remote.php/caldav` (Calendar sync)<br />`/remote.php/carddav` (Contacts sync)<br />`/ocs/v1.php` (API endpoints)<br />`/ocs/v2.php` (API v2 endpoints)<br />`/login` (Authentication)<br />`/.well-known/\*` (Service discovery)<br />`/.well-known/webfinger` (WebFinger protocol)<br />`/s/\*` (Shared files/folders) | | Nextcloud | `/` (Main interface)<br />`/index.php` (Core handler)<br />`/remote.php` (Remote access)<br />`/status.php` (Status checks)<br />`/ocs` (Collaboration Services API)<br />`/apps` (Applications)<br />`/remote.php/webdav` (WebDAV endpoint)<br />`/remote.php/dav` (CalDAV/CardDAV)<br />`/remote.php/caldav` (Calendar sync)<br />`/remote.php/carddav` (Contacts sync)<br />`/ocs/v1.php` (API endpoints)<br />`/ocs/v2.php` (API v2 endpoints)<br />`/login` (Authentication)<br />`/.well-known/*` (Service discovery)<br />`/.well-known/webfinger` (WebFinger protocol)<br />`/s/*` (Shared files/folders) |
| **Photo Management** | | | **Photo Management** | |
| Immich | `/api/\*`<br />`/.well-known/immich` | | Immich | `/api/*`<br />`/.well-known/immich` |
| **Notes & Knowledge Management** | | | **Notes & Knowledge Management** | |
| Joplin Notes Server | `/api/\*`<br />`/shares/\*`<br />`/css/\*`<br />`/images/\*`<br />Always Deny - Path - `/login/\*` (optional) | | Joplin Notes Server | `/api/*`<br />`/shares/*`<br />`/css/*`<br />`/images/*`<br />Always Deny - Path - `/login/*` (optional) |
| Erugo | `/api/\*`<br />`/shares/\*`<br />`/build/\*`<br />`/get-logo` | | Erugo | `/api/*`<br />`/shares/*`<br />`/build/*`<br />`/get-logo` |
| **Communication** | | | **Communication** | |
| Matrix/Synapse (Clients) | `/_matrix/\*`<br />`/_synapse/client/\*` | | Matrix/Synapse (Clients) | `/_matrix/*`<br />`/_synapse/client/*` |
| Matrix/Synapse (Federation) | `/_matrix/\*` | | Matrix/Synapse (Federation) | `/_matrix/*` |
| **Notifications** | | | **Notifications** | |
| Gotify | `/version`<br />`/message`<br />`/application`<br />`/client`<br />`/stream`<br />`/plugin`<br />`/health` | | Gotify | `/version`<br />`/message`<br />`/application`<br />`/client`<br />`/stream`<br />`/plugin`<br />`/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. 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: Examples:
- blog/posts - Matches exact path - `blog/posts` - Matches exact path
- blog/\* - Matches all paths under blog - `blog/*` - Matches all paths under blog
- \*/2023/\* - Matches any path with 2023 as a middle segment - `*/2023/*` - Matches any path with 2023 as a middle segment
- product\* - Matches paths starting with "product" - `product*` - Matches paths starting with "product"
- \*admin\* - Matches any path containing "admin" - `*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. 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]. 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: Examples:
- 144.234.11.22/24 - Matches all 256 IPs from 192.168.1.0 to 192.168.1.255 - `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) - `10.0.0.0/8` - Matches any IP starting with 10 (16.7 million addresses)
- 2001:db8::/32 - Matches a range of IPv6 addresses - `2001:db8::/32` - Matches a range of IPv6 addresses
- 0.0.0.0/0 - Matches all IPv4 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. 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. 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: Examples:
- 23.234.134.32 - `23.234.134.32`
- 34.45.245.64 - `34.45.245.64`
- 100.11.243.169 - `192.168.1.1`