homarr-dashboard/INDEXING_SETTINGS.md

229 lines
4.7 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🔍 Crawling & Indexing Settings Guide
Depending on what you're setting up, here are the best configurations:
---
## 1⃣ RSS Feed Refresh (In Homarr)
Homarr RSS widgets **don't have built-in refresh intervals** - they fetch on page load.
### For Auto-Refreshing RSS:
**Option A: Browser Extension**
- Use "RSS Feed Reader" or "Feedly" browser extensions
- Auto-refresh every 15-30 minutes
**Option B: Custom Script (Advanced)**
```bash
# Add to crontab for RSS refresh
echo "*/15 * * * * curl -s http://localhost:7575/api/refresh" | crontab -
```
**Option C: Use FreshRSS/Miniflux Instead**
- Deploy FreshRSS: `https://freshrss.lemonlink.eu`
- Add to Homarr as app
- Better RSS management with automatic crawling
---
## 2⃣ Prowlarr - Torrent/Usenet Indexing (Recommended)
If you want to index torrents/usenet for your *arr stack:
### Deploy Prowlarr
```yaml
# Add to your portainer-stack.yml
prowlarr:
container_name: prowlarr
image: lscr.io/linuxserver/prowlarr:latest
restart: unless-stopped
volumes:
- /opt/homarr/prowlarr:/config
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/Stockholm
ports:
- '9696:9696'
networks:
- homarr-network
```
### Best Prowlarr Indexer Settings
**Global Settings → Indexers:**
```
Minimum Seeders: 1
Retention: 0 (unlimited)
Maximum Size: 0 (unlimited)
RSS Sync Interval: 15 minutes
```
**Applications (Sync to *arr apps):**
```
Sonarr: http://sonarr:8989
Radarr: http://radarr:7878
Lidarr: http://lidarr:8686
Readarr: http://readarr:8787
```
### Best Public Indexers (Free)
| Indexer | Type | Speed | Notes |
|---------|------|-------|-------|
| 1337x | Torrent | ⭐⭐⭐ | Reliable, good for movies |
| ThePirateBay | Torrent | ⭐⭐ | Hit or miss |
| RARBG | Torrent | ⭐⭐⭐ | Currently dead, avoid |
| Jackett | Meta | ⭐⭐⭐ | Aggregates many |
| YTS | Torrent | ⭐⭐ | Low quality, small size |
### Best Private Indexers (If you have access)
- BTN (TV)
- PTP (Movies)
- RED (Music)
- GazelleGames (Games)
---
## 3⃣ Homarr Search & App Discovery
### Enable App Search
**Board Settings → Search:**
```
Enable Search: ✅
Include Apps: ✅
Include Widgets: ✅
Search Providers: All
```
### Keyboard Shortcuts
- `/` or `Ctrl+K` - Open search
- Type app name - Quick launch
### Best Icons for Auto-Discovery
When adding apps, use exact icon names:
```
proxmox → Uses Proxmox logo
sonarr → Uses Sonarr logo
plex → Uses Plex logo
portainer → Uses Portainer logo
```
---
## 4⃣ Docker Integration (Auto-Discover Containers)
### Enable Docker Integration
1. **Manage → Integrations → New**
2. Type: **Docker**
3. Name: "Local Docker"
4. Socket: `/var/run/docker.sock` (already mounted)
5. Save
### Container Labels for Auto-Indexing
Add labels to your containers for Homarr to auto-detect:
```yaml
# Example container with Homarr labels
myapp:
image: myapp:latest
labels:
- "homarr.enabled=true"
- "homarr.name=My App"
- "homarr.icon=myapp"
- "homarr.url=https://myapp.lemonlink.eu"
```
---
## 5⃣ DNS/Ad Blocking Indexing (Pi-hole/AdGuard)
### Pi-hole Integration
1. **Manage → Integrations → New**
2. Type: **Pi-hole**
3. Host: `http://pihole.lemonlink.eu`
4. API Key: (from Pi-hole admin → Settings → API)
5. Save
### AdGuard Integration
1. **Manage → Integrations → New**
2. Type: **AdGuard**
3. Host: `http://adguard.lemonlink.eu`
4. Username/Password
5. Save
### DNS Hole Widget Settings
```
Show chart: ✅
Show statistics: ✅
Update interval: 60 seconds
```
---
## 6⃣ Media Server Indexing (Plex/Jellyfin)
### Plex Integration
1. **Manage → Integrations → New**
2. Type: **Plex**
3. Host: `http://plex:32400` or `https://plex.lemonlink.eu`
4. API Key: (from Plex settings)
5. Save
### Jellyfin Integration
1. **Manage → Integrations → New**
2. Type: **Jellyfin**
3. Host: `http://jellyfin:8096`
4. API Key: (from Jellyfin admin → Advanced → API Keys)
5. Save
### Media Server Widget Settings
```
Show active streams: ✅
Show recently added: ✅
Update interval: 30 seconds
```
---
## 🏆 Recommended Complete Setup
### For RSS News:
```
Deploy: Miniflux or FreshRSS
Add to Homarr as app
Use RSS widget sparingly (slows page load)
```
### For Torrent/Usenet Indexing:
```
Deploy: Prowlarr + Jackett
Sync to: Sonarr, Radarr, Lidarr
Add to Homarr: App + Indexer Manager widget
```
### For App Discovery:
```
Enable: Docker integration
Use: Container labels for auto-discovery
Enable: Global search (Ctrl+K)
```
---
## ⚡ Quick Add to Your Stack
Want me to add Prowlarr to your `portainer-stack.yml`? Just let me know and I'll push the update!
Current setup works great - just add the integration in Homarr UI.