homelab-optimized/docs/services/individual/wg-easy.md

Wg Easy

🟢 Other Service

📋 Service Overview

Property	Value
Service Name	wg-easy
Host	concord_nuc
Category	Other
Difficulty	🟢
Docker Image	ghcr.io/wg-easy/wg-easy
Compose File	concord_nuc/wireguard.yaml
Directory	concord_nuc

🎯 Purpose

wg-easy 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 (concord_nuc)

Deployment

# Navigate to service directory
cd concord_nuc

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f wg-easy

🔧 Configuration

Docker Compose Configuration

cap_add:
- NET_ADMIN
- SYS_MODULE
container_name: wg-easy
environment:
- HASH_PASSWORD="REDACTED_PASSWORD"
- WG_HOST=vishconcord.tplinkdns.com
image: ghcr.io/wg-easy/wg-easy
ports:
- 51820:51820/udp
- 51821:51821/tcp
restart: unless-stopped
sysctls:
- net.ipv4.ip_forward=1
- net.ipv4.conf.all.src_valid_mark=1
volumes:
- ./config:/etc/wireguard
- /lib/modules:/lib/modules

Environment Variables

Variable	Value	Description
HASH_PASSWORD	***MASKED***	Configuration variable
WG_HOST	vishconcord.tplinkdns.com	Configuration variable

Port Mappings

Host Port	Container Port	Protocol	Purpose
51820	51820	UDP	Service port
51821	51821	TCP	Service port

Volume Mappings

Host Path	Container Path	Type	Purpose
./config	/etc/wireguard	bind	Configuration files
/lib/modules	/lib/modules	bind	Data storage

🌐 Access Information

Service ports: 51820:51820/udp, 51821:51821/tcp

🔒 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 wg-easy

# Restart service
docker-compose restart wg-easy

# Update service
docker-compose pull wg-easy
docker-compose up -d wg-easy

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

📚 Additional Resources

• Official Documentation: Check the official docs for wg-easy
• Docker Hub: ghcr.io/wg-easy/wg-easy
• 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 concord_nuc

---

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: concord_nuc/wireguard.yaml