# Apt Cacher Ng

**🟢 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | apt-cacher-ng |
| **Host** | Calypso |
| **Category** | Other |
| **Difficulty** | 🟢 |
| **Docker Image** | `sameersbn/apt-cacher-ng:latest` |
| **Compose File** | `Calypso/apt-cacher-ng/apt-cacher-ng.yml` |
| **Directory** | `Calypso/apt-cacher-ng` |

## 🎯 Purpose

apt-cacher-ng 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/apt-cacher-ng

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f apt-cacher-ng
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: apt-cacher-ng
dns:
- 1.1.1.1
- 8.8.8.8
environment:
- TZ=America/Los_Angeles
image: sameersbn/apt-cacher-ng:latest
network_mode: bridge
ports:
- 3142:3142
restart: unless-stopped
volumes:
- /volume1/docker/apt-cacher-ng/cache:/var/cache/apt-cacher-ng
- /volume1/docker/apt-cacher-ng/log:/var/log/apt-cacher-ng
- /volume1/docker/apt-cacher-ng/config:/etc/apt-cacher-ng

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `TZ` | `America/Los_Angeles` | Timezone setting |


### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 3142 | 3142 | TCP | Service port |


### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/volume1/docker/apt-cacher-ng/cache` | `/var/cache/apt-cacher-ng` | bind | Cache data |
| `/volume1/docker/apt-cacher-ng/log` | `/var/log/apt-cacher-ng` | bind | System logs |
| `/volume1/docker/apt-cacher-ng/config` | `/etc/apt-cacher-ng` | bind | Configuration files |


## 🌐 Access Information

Service ports: 3142:3142

## 🔒 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:
```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 apt-cacher-ng

# Restart service
docker-compose restart apt-cacher-ng

# Update service
docker-compose pull apt-cacher-ng
docker-compose up -d apt-cacher-ng

# Access service shell
docker-compose exec apt-cacher-ng /bin/bash
# or
docker-compose exec apt-cacher-ng /bin/sh
```

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for apt-cacher-ng
- **Docker Hub**: [sameersbn/apt-cacher-ng:latest](https://hub.docker.com/r/sameersbn/apt-cacher-ng: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/apt-cacher-ng/apt-cacher-ng.yml`