# Satisfactory Server

**🟢 Gaming Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | satisfactory-server |
| **Host** | homelab_vm |
| **Category** | Gaming |
| **Difficulty** | 🟢 |
| **Docker Image** | `wolveix/satisfactory-server:latest` |
| **Compose File** | `homelab_vm/satisfactory.yaml` |
| **Directory** | `homelab_vm` |

## 🎯 Purpose

Satisfactory dedicated server for multiplayer factory building in 3D.

## 🚀 Quick Start

### Prerequisites
- Docker and Docker Compose installed
- Basic understanding of REDACTED_APP_PASSWORD
- Access to the host system (homelab_vm)

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

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f satisfactory-server
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: satisfactory-server
deploy:
  resources:
    limits:
      memory: 6G
    reservations:
      memory: 4G
environment:
- MAXPLAYERS=4
- PGID=1000
- PUID=1000
- ROOTLESS=false
- STEAMBETA=false
healthcheck:
  interval: 30s
  retries: 3
  start_period: 120s
  test: bash /healthcheck.sh
  timeout: 10s
hostname: satisfactory-server
image: wolveix/satisfactory-server:latest
ports:
- 7777:7777/udp
- 7777:7777/tcp
restart: unless-stopped
volumes:
- /home/homelab/docker/sf:/data

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `MAXPLAYERS` | `4` | Configuration variable |
| `PGID` | `1000` | Group ID for file permissions |
| `PUID` | `1000` | User ID for file permissions |
| `ROOTLESS` | `false` | Configuration variable |
| `STEAMBETA` | `false` | Configuration variable |


### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 7777 | 7777 | UDP | Game server |
| 7777 | 7777 | TCP | Game server |


### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/home/homelab/docker/sf` | `/data` | bind | Application data |


## 🌐 Access Information

Service ports: 7777:7777/udp, 7777:7777/tcp

## 🔒 Security Considerations

- ⚠️ Consider adding security options (no-new-privileges)
- ⚠️ Consider running as non-root user

## 📊 Resource Requirements

**Memory Limit**: 6G

### 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**: `bash /healthcheck.sh`
**Check 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 satisfactory-server

# Restart service
docker-compose restart satisfactory-server

# Update service
docker-compose pull satisfactory-server
docker-compose up -d satisfactory-server

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for satisfactory-server
- **Docker Hub**: [wolveix/satisfactory-server:latest](https://hub.docker.com/r/wolveix/satisfactory-server: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 gaming category on homelab_vm

---

*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**: `homelab_vm/satisfactory.yaml`