homelab-optimized/docs/services/individual/calibre-web.md

Calibre Web

🟢 Media Service

📋 Service Overview

Property	Value
Service Name	calibre-web
Host	Atlantis
Category	Media
Difficulty	🟢
Docker Image	ghcr.io/linuxserver/calibre-web
Compose File	Atlantis/calibre-books.yml
Directory	Atlantis

🎯 Purpose

calibre-web 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

# Navigate to service directory
cd Atlantis

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f calibre-web

🔧 Configuration

Docker Compose Configuration

container_name: calibre-webui
environment:
- PUID=1026
- PGID=100
- TZ=America/Los_Angeles
- DOCKER_MODS=linuxserver/mods:universal-calibre
- OAUTHLIB_RELAX_TOKEN_SCOPE=1
image: ghcr.io/linuxserver/calibre-web
ports:
- 8083:8083
restart: always
volumes:
- /volume1/docker/calibreweb:/config
- /volume1/docker/books:/books

Environment Variables

Variable	Value	Description
PUID	1026	User ID for file permissions
PGID	100	Group ID for file permissions
TZ	America/Los_Angeles	Timezone setting
DOCKER_MODS	linuxserver/mods:universal-calibre	Configuration variable
OAUTHLIB_RELAX_TOKEN_SCOPE	***MASKED***	Configuration variable

Port Mappings

Host Port	Container Port	Protocol	Purpose
8083	8083	TCP	Service port

Volume Mappings

Host Path	Container Path	Type	Purpose
/volume1/docker/calibreweb	/config	bind	Configuration files
/volume1/docker/books	/books	bind	Data storage

🌐 Access Information

Service ports: 8083:8083

🔒 Security Considerations

• ⚠️ Consider adding security options (no-new-privileges)
• ⚠️ 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 calibre-web

# Restart service
docker-compose restart calibre-web

# Update service
docker-compose pull calibre-web
docker-compose up -d calibre-web

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

📚 Additional Resources

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

🔗 Related Services

Services REDACTED_APP_PASSWORD calibre-web:

• 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/calibre-books.yml