196 lines
4.5 KiB
Markdown
196 lines
4.5 KiB
Markdown
# Whisparr
|
|
|
|
**🟢 Other Service**
|
|
|
|
## 📋 Service Overview
|
|
|
|
| Property | Value |
|
|
|----------|-------|
|
|
| **Service Name** | whisparr |
|
|
| **Host** | Calypso |
|
|
| **Category** | Other |
|
|
| **Difficulty** | 🟢 |
|
|
| **Docker Image** | `ghcr.io/hotio/whisparr:latest` |
|
|
| **Compose File** | `Calypso/arr_suite_with_dracula.yml` |
|
|
| **Directory** | `Calypso` |
|
|
|
|
## 🎯 Purpose
|
|
|
|
whisparr is a specialized service that provides specific functionality for the homelab infrastructure.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Prerequisites
|
|
- Docker and Docker Compose installed
|
|
- Basic understanding of REDACTED_APP_PASSWORD
|
|
- Access to the host system (Calypso)
|
|
|
|
### Deployment
|
|
```bash
|
|
# Navigate to service directory
|
|
cd Calypso
|
|
|
|
# Start the service
|
|
docker-compose up -d
|
|
|
|
# Check service status
|
|
docker-compose ps
|
|
|
|
# View logs
|
|
docker-compose logs -f whisparr
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
### Docker Compose Configuration
|
|
```yaml
|
|
container_name: whisparr
|
|
environment:
|
|
- PUID=1027
|
|
- PGID=65536
|
|
- TZ=America/Los_Angeles
|
|
- UMASK=022
|
|
- TP_HOTIO=true
|
|
- TP_THEME=dracula
|
|
image: ghcr.io/hotio/whisparr:latest
|
|
networks:
|
|
media_net:
|
|
ipv4_address: 172.23.0.2
|
|
ports:
|
|
- 6969:6969/tcp
|
|
restart: always
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
volumes:
|
|
- /volume1/docker2/whisparr:/config
|
|
- /volume1/data:/data
|
|
|
|
```
|
|
|
|
### Environment Variables
|
|
| Variable | Value | Description |
|
|
|----------|-------|-------------|
|
|
| `PUID` | `1027` | User ID for file permissions |
|
|
| `PGID` | `65536` | Group ID for file permissions |
|
|
| `TZ` | `America/Los_Angeles` | Timezone setting |
|
|
| `UMASK` | `022` | Configuration variable |
|
|
| `TP_HOTIO` | `true` | Configuration variable |
|
|
| `TP_THEME` | `dracula` | Configuration variable |
|
|
|
|
|
|
### Port Mappings
|
|
| Host Port | Container Port | Protocol | Purpose |
|
|
|-----------|----------------|----------|----------|
|
|
| 6969 | 6969 | TCP | Service port |
|
|
|
|
|
|
### Volume Mappings
|
|
| Host Path | Container Path | Type | Purpose |
|
|
|-----------|----------------|------|----------|
|
|
| `/volume1/docker2/whisparr` | `/config` | bind | Configuration files |
|
|
| `/volume1/data` | `/data` | bind | Application data |
|
|
|
|
|
|
## 🌐 Access Information
|
|
|
|
Service ports: 6969:6969/tcp
|
|
|
|
## 🔒 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
|
|
|
|
### Useful Commands
|
|
```bash
|
|
# Check service status
|
|
docker-compose ps
|
|
|
|
# View real-time logs
|
|
docker-compose logs -f whisparr
|
|
|
|
# Restart service
|
|
docker-compose restart whisparr
|
|
|
|
# Update service
|
|
docker-compose pull whisparr
|
|
docker-compose up -d whisparr
|
|
|
|
# Access service shell
|
|
docker-compose exec whisparr /bin/bash
|
|
# or
|
|
docker-compose exec whisparr /bin/sh
|
|
```
|
|
|
|
## 📚 Additional Resources
|
|
|
|
- **Official Documentation**: Check the official docs for whisparr
|
|
- **Docker Hub**: [ghcr.io/hotio/whisparr:latest](https://hub.docker.com/r/ghcr.io/hotio/whisparr:latest)
|
|
- **Community Forums**: Search for community discussions and solutions
|
|
- **GitHub Issues**: Check the project's GitHub for known issues
|
|
|
|
## 🔗 Related Services
|
|
|
|
Other services in the other category on Calypso
|
|
|
|
---
|
|
|
|
*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**: `Calypso/arr_suite_with_dracula.yml`
|