homelab-optimized/docs/services/individual/nginx.md

Nginx

🟡 Networking Service

📋 Service Overview

Property	Value
Service Name	nginx
Host	guava
Category	Networking
Difficulty	🟡
Docker Image	nginx:latest
Compose File	guava/portainer_yaml/nginx.yaml
Directory	guava/portainer_yaml

🎯 Purpose

NGINX is a web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache.

🚀 Quick Start

Prerequisites

• Docker and Docker Compose installed
• Basic understanding of REDACTED_APP_PASSWORD
• Access to the host system (guava)

Deployment

# Navigate to service directory
cd guava/portainer_yaml

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f nginx

🔧 Configuration

Docker Compose Configuration

container_name: nginx
image: nginx:latest
networks:
- web-net
ports:
- 28888:80
restart: unless-stopped
volumes:
- /mnt/data/website/html:/usr/share/nginx/html:ro
- /mnt/data/website/conf.d:/etc/nginx/conf.d:ro

Environment Variables

No environment variables configured.

Port Mappings

Host Port	Container Port	Protocol	Purpose
28888	80	TCP	HTTP web interface

Volume Mappings

Host Path	Container Path	Type	Purpose
/mnt/data/website/html	/usr/share/nginx/html	bind	Data storage
/mnt/data/website/conf.d	/etc/nginx/conf.d	bind	Configuration files

🌐 Access Information

Web Interface

• HTTP: http://guava:28888

Default Credentials

Refer to service documentation for default credentials

🔒 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:

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 nginx

# Restart service
docker-compose restart nginx

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

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

📚 Additional Resources

• Official Documentation: Check the official docs for nginx
• Docker Hub: Official nginx
• Community Forums: Search for community discussions and solutions
• GitHub Issues: Check the project's GitHub for known issues

🔗 Related Services

Other services in the networking category on guava

---

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: guava/portainer_yaml/nginx.yaml