mirror of
https://github.com/calibrain/shelfmark.git
synced 2026-04-20 22:09:28 -04:00
e5ccabe1ef
- Added rich Prowlarr search results for whitelisted indexers - Added torznab query for whitelisted indexers - Added flags for all Prowlarr indexers - Added completed external download retry mechanism and "locating" state - Added client side preference storage of Book/Audiobook search preference - Fixed reverse proxy base URL in edge cases - Added gevent locking for I/O operations, keeps healthcheck alive on intensive processing operations - Added M4A supported audiobook option - Improved file transfer counting and logging with hardlink fallback warnings - Fixed proxy auth header for REMOTE_USER scenario - Dependency tweak for internal bypasser
148 lines
4.5 KiB
Markdown
148 lines
4.5 KiB
Markdown
# Reverse Proxy & Subpath Hosting
|
|
|
|
Shelfmark can run behind a reverse proxy at the root path (recommended) or under a subpath like `/shelfmark`.
|
|
|
|
## Root path setup (Recommended)
|
|
|
|
If you can serve Shelfmark at the root path (`https://shelfmark.example.com/`), leave `URL_BASE` empty. This is the simplest option and avoids extra subpath configuration.
|
|
|
|
```nginx
|
|
server {
|
|
listen 443 ssl;
|
|
server_name shelfmark.example.com;
|
|
|
|
location / {
|
|
proxy_pass http://shelfmark:8084;
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Host $host;
|
|
proxy_set_header X-Real-IP $remote_addr;
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
proxy_set_header X-Forwarded-Proto $scheme;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
}
|
|
}
|
|
```
|
|
|
|
## Subpath setup
|
|
|
|
Running Shelfmark under a subpath like `/shelfmark` is supported without extra rewrite rules.
|
|
|
|
### 1. Set the base path in Shelfmark
|
|
|
|
- **UI**: Settings → Advanced → Base Path → `/shelfmark/`
|
|
- **Environment variable**: `URL_BASE=/shelfmark/`
|
|
|
|
### 2. Configure your reverse proxy
|
|
|
|
All Shelfmark paths (UI, API, assets, Socket.IO) are served under the base path. A single location block is enough.
|
|
|
|
---
|
|
|
|
### Without Authentication Proxy
|
|
|
|
**Complete Nginx configuration for subpath deployment:**
|
|
|
|
```nginx
|
|
location /shelfmark/ {
|
|
proxy_pass http://shelfmark:8084/shelfmark/;
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Host $host;
|
|
proxy_set_header X-Real-IP $remote_addr;
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
proxy_set_header X-Forwarded-Proto $scheme;
|
|
proxy_set_header X-Forwarded-Host $host;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
proxy_read_timeout 86400;
|
|
proxy_send_timeout 86400;
|
|
proxy_buffering off;
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
### With Authentication Proxy (Authelia, Authentik, etc.)
|
|
|
|
Shelfmark supports Proxy Authentication. When enabled, Shelfmark trusts the authenticated user from headers set by your auth proxy.
|
|
|
|
#### Shelfmark Settings
|
|
|
|
Configure in Settings → Security:
|
|
|
|
| Setting | Value |
|
|
|---------|-------|
|
|
| Authentication Method | Proxy Authentication |
|
|
| Proxy Auth User Header | `Remote-User` |
|
|
| Proxy Auth Logout URL | `https://auth.example.com/logout` |
|
|
| Proxy Auth Admin Group Header | `Remote-Groups` |
|
|
| Proxy Auth Admin Group Name | `admins` (or your admin group) |
|
|
|
|
#### Nginx Configuration with Authelia
|
|
|
|
This example uses Authelia snippets. Adapt for your auth proxy.
|
|
|
|
**Authelia auth request snippet** (`/etc/nginx/snippets/authelia-authrequest.conf`):
|
|
|
|
```nginx
|
|
location /authelia {
|
|
internal;
|
|
proxy_pass http://authelia:9091/api/authz/auth-request;
|
|
proxy_pass_request_body off;
|
|
proxy_set_header Content-Length "";
|
|
proxy_set_header Host $host;
|
|
proxy_set_header X-Original-URL $scheme://$http_host$request_uri;
|
|
proxy_set_header X-Original-Method $request_method;
|
|
proxy_set_header X-Real-IP $remote_addr;
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
proxy_set_header X-Forwarded-Proto $scheme;
|
|
}
|
|
```
|
|
|
|
**Authelia location snippet** (`/etc/nginx/snippets/authelia-location.conf`):
|
|
|
|
```nginx
|
|
auth_request /authelia;
|
|
auth_request_set $target_url $scheme://$http_host$request_uri;
|
|
auth_request_set $user $upstream_http_remote_user;
|
|
auth_request_set $groups $upstream_http_remote_groups;
|
|
auth_request_set $name $upstream_http_remote_name;
|
|
auth_request_set $email $upstream_http_remote_email;
|
|
proxy_set_header Remote-User $user;
|
|
proxy_set_header Remote-Groups $groups;
|
|
proxy_set_header Remote-Name $name;
|
|
proxy_set_header Remote-Email $email;
|
|
error_page 401 =302 https://auth.example.com/?rd=$target_url;
|
|
```
|
|
|
|
**Complete Nginx configuration with Authelia:**
|
|
|
|
```nginx
|
|
# Include Authelia auth endpoint in your server block
|
|
include /etc/nginx/snippets/authelia-authrequest.conf;
|
|
|
|
# Main shelfmark location
|
|
location /shelfmark/ {
|
|
include /etc/nginx/snippets/authelia-location.conf;
|
|
|
|
proxy_pass http://shelfmark:8084/shelfmark/;
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Host $host;
|
|
proxy_set_header X-Real-IP $remote_addr;
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
proxy_set_header X-Forwarded-Proto $scheme;
|
|
proxy_set_header X-Forwarded-Host $host;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
proxy_read_timeout 86400;
|
|
proxy_send_timeout 86400;
|
|
proxy_buffering off;
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Health checks
|
|
|
|
Health checks work at `/shelfmark/api/health` when using a subpath configuration.
|