homelab-optimized/docs/services/individual/immich-db.md

Immich Db

🟡 Media Service

📋 Service Overview

Property	Value
Service Name	immich-db
Host	Calypso
Category	Media
Difficulty	🟡
Docker Image	ghcr.io/immich-app/postgres:16-vectorchord0.4.3-pgvectors0.2.0
Compose File	Calypso/immich/docker-compose.yml
Directory	Calypso/immich

🎯 Purpose

High performance self-hosted photo and video backup solution.

🚀 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/immich

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f immich-db

🔧 Configuration

Docker Compose Configuration

container_name: Immich-DB
environment:
- TZ=America/Los_Angeles
- POSTGRES_DB=immich
- POSTGRES_USER=immichuser
- POSTGRES_PASSWORD="REDACTED_PASSWORD"
- DB_STORAGE_TYPE=HDD
healthcheck:
  interval: 10s
  retries: 5
  test:
  - CMD
  - pg_isready
  - -q
  - -d
  - immich
  - -U
  - immichuser
  timeout: 5s
hostname: immich-db
image: ghcr.io/immich-app/postgres:16-vectorchord0.4.3-pgvectors0.2.0
restart: on-failure:5
security_opt:
- no-new-privileges:true
shm_size: 128mb
volumes:
- /volume1/docker/immich/db:/var/lib/postgresql/data:rw

Environment Variables

Variable	Value	Description
TZ	America/Los_Angeles	Timezone setting
POSTGRES_DB	immich	Configuration variable
POSTGRES_USER	immichuser	Configuration variable
POSTGRES_PASSWORD	***MASKED***	PostgreSQL password
DB_STORAGE_TYPE	HDD	Configuration variable

Port Mappings

No ports exposed.

Volume Mappings

Host Path	Container Path	Type	Purpose
/volume1/docker/immich/db	/var/lib/postgresql/data	bind	Application data

🌐 Access Information

This service does not expose any web interfaces.

🔒 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

✅ Health check configured Test Command: CMD pg_isready -q -d immich -U immichuser Check Interval: 10s Timeout: 5s Retries: 5

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 immich-db

# Restart service
docker-compose restart immich-db

# Update service
docker-compose pull immich-db
docker-compose up -d immich-db

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

📚 Additional Resources

• Official Documentation: Check the official docs for immich-db
• Docker Hub: ghcr.io/immich-app/postgres:16-vectorchord0.4.3-pgvectors0.2.0
• Community Forums: Search for community discussions and solutions
• GitHub Issues: Check the project's GitHub for known issues

🔗 Related Services

Services REDACTED_APP_PASSWORD immich-db:

• 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/immich/docker-compose.yml