# Wgeasy

**🟢 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | wgeasy |
| **Host** | Calypso |
| **Category** | Other |
| **Difficulty** | 🟢 |
| **Docker Image** | `ghcr.io/wg-easy/wg-easy:latest` |
| **Compose File** | `Calypso/wireguard-server.yaml` |
| **Directory** | `Calypso` |

## 🎯 Purpose

wgeasy 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 (Calypso)

### Deployment
```bash
# Navigate to service directory
cd Calypso

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

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

## 🔧 Configuration

### Docker Compose Configuration
```yaml
cap_add:
- NET_ADMIN
- SYS_MODULE
container_name: wgeasy
environment:
- WG_HOST=vishconcord.synology.me
- HASH_PASSWORD="REDACTED_PASSWORD"
image: ghcr.io/wg-easy/wg-easy:latest
network_mode: bridge
ports:
- 51820:51820/udp
- 51821:51821
restart: always
sysctls:
- net.ipv4.conf.all.src_valid_mark=1
- net.ipv4.ip_forward=1
volumes:
- /volume1/docker/wg:/etc/wireguard

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `WG_HOST` | `vishconcord.synology.me` | Configuration variable |
| `HASH_PASSWORD` | `***MASKED***` | 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 |
|-----------|----------------|------|----------|
| `/volume1/docker/wg` | `/etc/wireguard` | bind | Configuration files |


## 🌐 Access Information

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

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

# Restart service
docker-compose restart wgeasy

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

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for wgeasy
- **Docker Hub**: [ghcr.io/wg-easy/wg-easy:latest](https://hub.docker.com/r/ghcr.io/wg-easy/wg-easy: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 Calypso

---

*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**: `Calypso/wireguard-server.yaml`