homelab-optimized/docs/services/individual/readarr.md

Readarr

🟢 Media Service

📋 Service Overview

Property	Value
Service Name	readarr
Host	Calypso
Category	Media
Difficulty	🟢
Docker Image	lscr.io/linuxserver/readarr:0.4.19-nightly
Compose File	Calypso/arr_suite_with_dracula.yml
Directory	Calypso

🎯 Purpose

readarr 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 (Calypso)

Deployment

# 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 readarr

🔧 Configuration

Docker Compose Configuration

container_name: readarr
environment:
- PUID=1027
- PGID=65536
- TZ=America/Los_Angeles
- UMASK=022
- DOCKER_MODS=ghcr.io/themepark-dev/theme.park:readarr
- TP_THEME=dracula
image: lscr.io/linuxserver/readarr:0.4.19-nightly
networks:
  media_net:
    ipv4_address: 172.23.0.4
ports:
- 8787:8787/tcp
restart: always
security_opt:
- no-new-privileges:true
volumes:
- /volume1/docker2/readarr:/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
DOCKER_MODS	ghcr.io/themepark-dev/theme.park:readarr	Configuration variable
TP_THEME	dracula	Configuration variable

Port Mappings

Host Port	Container Port	Protocol	Purpose
8787	8787	TCP	Service port

Volume Mappings

Host Path	Container Path	Type	Purpose
/volume1/docker2/readarr	/config	bind	Configuration files
/volume1/data	/data	bind	Application data

🌐 Access Information

Service ports: 8787:8787/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:

docker stats

🔍 Health Monitoring

⚠️ No health check configured Consider adding a health check:

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
  interval: 30s
  timeout: 10s
  retries: 3

Manual Health Checks

# 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

# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f readarr

# Restart service
docker-compose restart readarr

# Update service
docker-compose pull readarr
docker-compose up -d readarr

# Access service shell
docker-compose exec readarr /bin/bash
# or
docker-compose exec readarr /bin/sh

📚 Additional Resources

• Official Documentation: Check the official docs for readarr
• Docker Hub: lscr.io/linuxserver/readarr:0.4.19-nightly
• Community Forums: Search for community discussions and solutions
• GitHub Issues: Check the project's GitHub for known issues

🔗 Related Services

Services REDACTED_APP_PASSWORD readarr:

• 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: Calypso/arr_suite_with_dracula.yml