4.2 KiB
4.2 KiB
Hyperpipe Back
🟡 Other Service
📋 Service Overview
| Property | Value |
|---|---|
| Service Name | hyperpipe-back |
| Host | Atlantis |
| Category | Other |
| Difficulty | 🟡 |
| Docker Image | codeberg.org/hyperpipe/hyperpipe-backend:latest |
| Compose File | Atlantis/piped.yml |
| Directory | Atlantis |
🎯 Purpose
hyperpipe-back 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
# 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-back
🔧 Configuration
Docker Compose Configuration
container_name: Hyperpipe-API
cpu_shares: 768
depends_on:
nginx:
condition: service_healthy
environment:
HYP_PROXY: hyperpipe-proxy.onrender.com
hostname: hyperpipe-backend
image: codeberg.org/hyperpipe/hyperpipe-backend:latest
mem_limit: 512m
ports:
- 3771:3000
read_only: true
restart: on-failure:5
security_opt:
- no-new-privileges:true
user: 1026:100
Environment Variables
| Variable | Value | Description |
|---|---|---|
HYP_PROXY |
hyperpipe-proxy.onrender.com |
Configuration variable |
Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|---|---|---|---|
| 3771 | 3000 | TCP | Web interface |
Volume Mappings
No volumes mounted.
🌐 Access Information
Web Interface
- HTTP:
http://Atlantis:3771
Default Credentials
Refer to service documentation for default credentials
🔒 Security Considerations
- ✅ Security options configured
- ✅ Non-root user configured
- ✅ Read-only root filesystem
📊 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
⚠️ No health check configured Consider adding a health check:
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
interval: 30s
timeout: 10s
retries: 3
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
Useful Commands
# Check service status
docker-compose ps
# View real-time logs
docker-compose logs -f hyperpipe-back
# Restart service
docker-compose restart hyperpipe-back
# Update service
docker-compose pull hyperpipe-back
docker-compose up -d hyperpipe-back
# Access service shell
docker-compose exec hyperpipe-back /bin/bash
# or
docker-compose exec hyperpipe-back /bin/sh
📚 Additional Resources
- Official Documentation: Check the official docs for hyperpipe-back
- Docker Hub: codeberg.org/hyperpipe/hyperpipe-backend: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