# Coturn

**🟡 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | coturn |
| **Host** | Atlantis |
| **Category** | Other |
| **Difficulty** | 🟡 |
| **Docker Image** | `instrumentisto/coturn:latest` |
| **Compose File** | `Atlantis/matrix_synapse_docs/turnserver_docker_compose.yml` |
| **Directory** | `Atlantis/matrix_synapse_docs` |

## 🎯 Purpose

coturn 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 (Atlantis)

### Deployment
```bash
# Navigate to service directory
cd Atlantis/matrix_synapse_docs

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f coturn
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
command:
- turnserver
- -c
- /config/turnserver.conf
container_name: coturn
environment:
- TZ=America/Los_Angeles
image: instrumentisto/coturn:latest
networks:
  turn_net:
    ipv4_address: 172.25.0.2
ports:
- 3478:3478/tcp
- 3478:3478/udp
- 5349:5349/tcp
- 5349:5349/udp
- 49160-49200:49160-49200/udp
restart: unless-stopped
ulimits:
  nofile:
    hard: 65536
    soft: 65536
volumes:
- /volume1/docker/turnserver/turnserver.conf:/config/turnserver.conf:ro
- /volume1/docker/turnserver/certs:/config/certs:ro
- /volume1/docker/turnserver/logs:/var/log
- /volume1/docker/turnserver/db:/var/lib/coturn

```

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


### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 3478 | 3478 | TCP | Service port |
| 3478 | 3478 | UDP | Service port |
| 5349 | 5349 | TCP | Service port |
| 5349 | 5349 | UDP | Service port |
| 49160-49200 | 49160-49200 | UDP | Service port |


### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/volume1/docker/turnserver/turnserver.conf` | `/config/turnserver.conf` | bind | Configuration files |
| `/volume1/docker/turnserver/certs` | `/config/certs` | bind | Configuration files |
| `/volume1/docker/turnserver/logs` | `/var/log` | bind | System logs |
| `/volume1/docker/turnserver/db` | `/var/lib/coturn` | bind | Service data |


## 🌐 Access Information

Service ports: 3478:3478/tcp, 3478:3478/udp, 5349:5349/tcp, 5349:5349/udp, 49160-49200:49160-49200/udp

## 🔒 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 coturn

# Restart service
docker-compose restart coturn

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

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for coturn
- **Docker Hub**: [instrumentisto/coturn:latest](https://hub.docker.com/r/instrumentisto/coturn: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 Atlantis

---

*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/matrix_synapse_docs/turnserver_docker_compose.yml`
