Sanitized mirror from private repository - 2026-04-20 01:32:01 UTC

docs/services/individual/jackett.md

@@ -0,0 +1,205 @@
+# Jackett
+
+**🟢 Media Service**
+
+## 📋 Service Overview
+
+| Property | Value |
+|----------|-------|
+| **Service Name** | jackett |
+| **Host** | Atlantis |
+| **Category** | Media |
+| **Difficulty** | 🟢 |
+| **Docker Image** | `lscr.io/linuxserver/jackett:latest` |
+| **Compose File** | `Atlantis/arr-suite/docker-compose.yml` |
+| **Directory** | `Atlantis/arr-suite` |
+
+## 🎯 Purpose
+
+jackett is a media management and streaming service that helps organize and serve your digital media content.
+
+## 🚀 Quick Start
+
+### Prerequisites
+- Docker and Docker Compose installed
+- Basic understanding of REDACTED_APP_PASSWORD
+- Access to the host system (Atlantis)
+
+### Deployment
+```bash
+# Navigate to service directory
+cd Atlantis/arr-suite
+
+# Start the service
+docker-compose up -d
+
+# Check service status
+docker-compose ps
+
+# View logs
+docker-compose logs -f jackett
+```
+
+## 🔧 Configuration
+
+### Docker Compose Configuration
+```yaml
+container_name: jackett
+environment:
+- PUID=1029
+- PGID=65536
+- TZ=America/Los_Angeles
+- UMASK=022
+- DOCKER_MODS=ghcr.io/themepark-dev/theme.park:jackett
+- TP_THEME=dracula
+image: lscr.io/linuxserver/jackett:latest
+networks:
+  media2_net:
+    ipv4_address: 172.24.0.11
+ports:
+- 9117:9117
+restart: always
+security_opt:
+- no-new-privileges:true
+volumes:
+- /volume1/docker2/jackett:/config
+- /volume1/data:/downloads
+
+```
+
+### Environment Variables
+| Variable | Value | Description |
+|----------|-------|-------------|
+| `PUID` | `1029` | User ID for file permissions |
+| `PGID` | `65536` | Group ID for file permissions |
+| `TZ` | `America/Los_Angeles` | Timezone setting |
+| `UMASK` | `022` | Configuration variable |
+| `DOCKER_MODS` | `ghcr.io/themepark-dev/theme.park:jackett` | Configuration variable |
+| `TP_THEME` | `dracula` | Configuration variable |
+
+
+### Port Mappings
+| Host Port | Container Port | Protocol | Purpose |
+|-----------|----------------|----------|----------|
+| 9117 | 9117 | TCP | Service port |
+
+
+### Volume Mappings
+| Host Path | Container Path | Type | Purpose |
+|-----------|----------------|------|----------|
+| `/volume1/docker2/jackett` | `/config` | bind | Configuration files |
+| `/volume1/data` | `/downloads` | bind | Downloaded files |
+
+
+## 🌐 Access Information
+
+Service ports: 9117:9117
+
+## 🔒 Security Considerations
+
+- ✅ Security options configured
+- ⚠️ Consider running as non-root user
+
+## 📊 Resource Requirements
+
+No resource limits configured
+
+### Recommended Resources
+- **Minimum RAM**: 512MB
+- **Recommended RAM**: 1GB+
+- **CPU**: 1 core minimum
+- **Storage**: Varies by usage
+
+### Resource Monitoring
+Monitor resource usage with:
+```bash
+docker stats
+```
+
+## 🔍 Health Monitoring
+
+⚠️ No health check configured
+Consider adding a health check:
+```yaml
+healthcheck:
+  test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
+  interval: 30s
+  timeout: 10s
+  retries: 3
+```
+
+### Manual Health Checks
+```bash
+# Check container health
+docker inspect --format='{{.State.Health.Status}}' CONTAINER_NAME
+
+# View health check logs
+docker inspect --format='{{range .State.Health.Log}}{{.Output}}{{end}}' CONTAINER_NAME
+```
+
+## 🚨 Troubleshooting
+
+### Common Issues
+**Service won't start**
+- Check Docker logs: `docker-compose logs service-name`
+- Verify port availability: `netstat -tulpn | grep PORT`
+- Check file permissions on mounted volumes
+
+**Can't access web interface**
+- Verify service is running: `docker-compose ps`
+- Check firewall settings
+- Confirm correct port mapping
+
+**Performance issues**
+- Monitor resource usage: `docker stats`
+- Check available disk space: `df -h`
+- Review service logs for errors
+
+**Media not showing**
+- Check media file permissions
+- Verify volume mounts are correct
+- Scan media library manually
+
+### Useful Commands
+```bash
+# Check service status
+docker-compose ps
+
+# View real-time logs
+docker-compose logs -f jackett
+
+# Restart service
+docker-compose restart jackett
+
+# Update service
+docker-compose pull jackett
+docker-compose up -d jackett
+
+# Access service shell
+docker-compose exec jackett /bin/bash
+# or
+docker-compose exec jackett /bin/sh
+```
+
+## 📚 Additional Resources
+
+- **Official Documentation**: Check the official docs for jackett
+- **Docker Hub**: [lscr.io/linuxserver/jackett:latest](https://hub.docker.com/r/lscr.io/linuxserver/jackett:latest)
+- **Community Forums**: Search for community discussions and solutions
+- **GitHub Issues**: Check the project's GitHub for known issues
+
+## 🔗 Related Services
+
+Services REDACTED_APP_PASSWORD jackett:
+- Plex
+- Jellyfin
+- Radarr
+- Sonarr
+- Bazarr
+
+---
+
+*This documentation is auto-generated from the Docker Compose configuration. For the most up-to-date information, refer to the official documentation and the actual compose file.*
+
+**Last Updated**: 2025-11-17  
+**Configuration Source**: `Atlantis/arr-suite/docker-compose.yml`