# Front

**🟢 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | front |
| **Host** | Atlantis |
| **Category** | Other |
| **Difficulty** | 🟢 |
| **Docker Image** | `ghcr.io/getumbrel/llama-gpt-ui:latest` |
| **Compose File** | `Atlantis/llamagpt.yml` |
| **Directory** | `Atlantis` |

## 🎯 Purpose

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

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: LlamaGPT
cpu_shares: 768
environment:
- OPENAI_API_KEY=REDACTED_API_KEY
- OPENAI_API_HOST=http://llamagpt-api:8000
- DEFAULT_MODEL=/models/llama-2-7b-chat.bin
- WAIT_HOSTS=llamagpt-api:8000
- WAIT_TIMEOUT=600
healthcheck:
  test: wget --no-verbose --tries=1 --spider http://localhost:3000
hostname: llamagpt
image: ghcr.io/getumbrel/llama-gpt-ui:latest
mem_limit: 1g
ports:
- 3136:3000
restart: on-failure:5
security_opt:
- no-new-privileges:true

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `OPENAI_API_KEY` | `***MASKED***` | Configuration variable |
| `OPENAI_API_HOST` | `http://llamagpt-api:8000` | Configuration variable |
| `DEFAULT_MODEL` | `/models/llama-2-7b-chat.bin` | Configuration variable |
| `WAIT_HOSTS` | `llamagpt-api:8000` | Configuration variable |
| `WAIT_TIMEOUT` | `600` | Configuration variable |


### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 3136 | 3000 | TCP | Web interface |


### Volume Mappings
No volumes mounted.

## 🌐 Access Information

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

### 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:3000`

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

# Restart service
docker-compose restart front

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

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for front
- **Docker Hub**: [ghcr.io/getumbrel/llama-gpt-ui:latest](https://hub.docker.com/r/ghcr.io/getumbrel/llama-gpt-ui: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/llamagpt.yml`
