# Hyperpipe Front

**🟡 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | hyperpipe-front |
| **Host** | Atlantis |
| **Category** | Other |
| **Difficulty** | 🟡 |
| **Docker Image** | `codeberg.org/hyperpipe/hyperpipe:latest` |
| **Compose File** | `Atlantis/piped.yml` |
| **Directory** | `Atlantis` |

## 🎯 Purpose

hyperpipe-front 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

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f hyperpipe-front
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: Hyperpipe-FRONTEND
cpu_shares: 768
depends_on:
  hyperpipe-back:
    condition: service_started
entrypoint: sh -c 'find /usr/share/nginx/html -type f -exec sed -i s/pipedapi.kavin.rocks/pipedapi.vishinator.synology.me/g
  {} \; -exec sed -i s/hyperpipeapi.onrender.com/hyperpipeapi.vishinator.synology.me/g
  {} \; && /docker-entrypoint.sh && nginx -g "daemon off;"'
healthcheck:
  test: wget --no-verbose --tries=1 --spider http://localhost
hostname: hyperpipe-frontend
image: codeberg.org/hyperpipe/hyperpipe:latest
mem_limit: 512m
ports:
- 8745:80
restart: on-failure:5
security_opt:
- no-new-privileges:true

```

### Environment Variables
No environment variables configured.

### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 8745 | 80 | TCP | HTTP web interface |


### Volume Mappings
No volumes mounted.

## 🌐 Access Information

### Web Interface
- **HTTP**: `http://Atlantis:8745`

### Default Credentials
Refer to service documentation for default credentials

## 🔒 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:
```bash
docker stats
```

## 🔍 Health Monitoring

✅ Health check configured
**Test Command**: `wget --no-verbose --tries=1 --spider http://localhost`

### 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 hyperpipe-front

# Restart service
docker-compose restart hyperpipe-front

# Update service
docker-compose pull hyperpipe-front
docker-compose up -d hyperpipe-front

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for hyperpipe-front
- **Docker Hub**: [codeberg.org/hyperpipe/hyperpipe:latest](https://hub.docker.com/r/codeberg.org/hyperpipe/hyperpipe: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/piped.yml`
