# Immich Machine Learning

**🟡 Media Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | immich-machine-learning |
| **Host** | Calypso |
| **Category** | Media |
| **Difficulty** | 🟡 |
| **Docker Image** | `ghcr.io/immich-app/immich-machine-learning:release` |
| **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
```bash
# 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-machine-learning
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: Immich-LEARNING
depends_on:
  immich-db:
    condition: service_started
env_file:
- stack.env
environment:
- MPLCONFIGDIR=/matplotlib
hostname: immich-machine-learning
image: ghcr.io/immich-app/immich-machine-learning:release
restart: on-failure:5
security_opt:
- no-new-privileges:true
user: 1026:100
volumes:
- /volume1/docker/immich/upload:/data:rw
- /volume1/docker/immich/external_photos/photos:/external/photos:rw
- /volume1/docker/immich/cache:/cache:rw
- /volume1/docker/immich/cache:/.cache:rw
- /volume1/docker/immich/cache:/.config:rw
- /volume1/docker/immich/matplotlib:/matplotlib:rw

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `MPLCONFIGDIR` | `/matplotlib` | Configuration variable |


### Port Mappings
No ports exposed.

### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/volume1/docker/immich/upload` | `/data` | bind | Application data |
| `/volume1/docker/immich/external_photos/photos` | `/external/photos` | bind | Data storage |
| `/volume1/docker/immich/cache` | `/cache` | bind | Cache data |
| `/volume1/docker/immich/cache` | `/.cache` | bind | Data storage |
| `/volume1/docker/immich/cache` | `/.config` | bind | Data storage |
| `/volume1/docker/immich/matplotlib` | `/matplotlib` | bind | Data storage |


## 🌐 Access Information

This service does not expose any web interfaces.

## 🔒 Security Considerations

- ✅ Security options configured
- ✅ Non-root user configured

## 📊 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 immich-machine-learning

# Restart service
docker-compose restart immich-machine-learning

# Update service
docker-compose pull immich-machine-learning
docker-compose up -d immich-machine-learning

# Access service shell
docker-compose exec immich-machine-learning /bin/bash
# or
docker-compose exec immich-machine-learning /bin/sh
```

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for immich-machine-learning
- **Docker Hub**: [ghcr.io/immich-app/immich-machine-learning:release](https://hub.docker.com/r/ghcr.io/immich-app/immich-machine-learning:release)
- **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-machine-learning:
- 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`
