# Stirling Pdf

**🟡 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | stirling-pdf |
| **Host** | Atlantis |
| **Category** | Other |
| **Difficulty** | 🟡 |
| **Docker Image** | `docker.stirlingpdf.com/stirlingtools/stirling-pdf` |
| **Compose File** | `Atlantis/stirlingpdf.yml` |
| **Directory** | `Atlantis` |

## 🎯 Purpose

stirling-pdf 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 stirling-pdf
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: Stirling-PDF
cpu_shares: 1024
environment:
  DISABLE_ADDITIONAL_FEATURES: false
  DISABLE_PIXEL: true
  INSTALL_BOOK_AND_ADVANCED_HTML_OPS: false
  METRICS_ENABLED: true
  PGID: 100
  PUID: 1026
  SECURITY_CSRFDISABLED: true
  SECURITY_ENABLE_LOGIN: true
  SECURITY_INITIAL_LOGIN_PASSWORD: "REDACTED_PASSWORD"
  SECURITY_INITIAL_LOGIN_USERNAME: vish
  SYSTEM_DEFAULTLOCALE: en-US
  SYSTEM_GOOGLEVISIBILITY: false
  SYSTEM_MAXFILESIZE: 5000
  UI_APPNAME: vishPDF
  UI_APPNAMENAVBAR: vish PDF
  UI_HOMEDESCRIPTION: vishPDF site
healthcheck:
  interval: 10s
  retries: 3
  start_period: 90s
  test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8080' || exit 1
  timeout: 5s
image: docker.stirlingpdf.com/stirlingtools/stirling-pdf
mem_limit: 4g
ports:
- 7890:8080
restart: on-failure:5
security_opt:
- no-new-privileges:true
volumes:
- /volume1/docker/stirling/data:/usr/share/tessdata:rw
- /volume1/docker/stirling/config:/configs:rw
- /volume1/docker/stirling/logs:/logs:rw
- /volume1/docker/stirling/customfiles:/customFiles:rw
- /volume1/docker/stirling/pipeline:/pipeline:rw

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `PUID` | `1026` | User ID for file permissions |
| `PGID` | `100` | Group ID for file permissions |
| `DISABLE_ADDITIONAL_FEATURES` | `False` | Configuration variable |
| `SECURITY_ENABLE_LOGIN` | `True` | Configuration variable |
| `SECURITY_INITIAL_LOGIN_USERNAME` | `vish` | Configuration variable |
| `SECURITY_INITIAL_LOGIN_PASSWORD` | `***MASKED***` | Configuration variable |
| `INSTALL_BOOK_AND_ADVANCED_HTML_OPS` | `False` | Configuration variable |
| `SECURITY_CSRFDISABLED` | `True` | Configuration variable |
| `SYSTEM_DEFAULTLOCALE` | `en-US` | Configuration variable |
| `UI_APPNAME` | `vishPDF` | Configuration variable |
| `UI_HOMEDESCRIPTION` | `vishPDF site` | Configuration variable |
| `UI_APPNAMENAVBAR` | `vish PDF` | Configuration variable |
| `SYSTEM_MAXFILESIZE` | `5000` | Configuration variable |
| `METRICS_ENABLED` | `True` | Configuration variable |
| `DISABLE_PIXEL` | `True` | Configuration variable |
| `SYSTEM_REDACTED_APP_PASSWORD` | `False` | Configuration variable |


### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 7890 | 8080 | TCP | Alternative HTTP port |


### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/volume1/docker/stirling/data` | `/usr/share/tessdata` | bind | Data storage |
| `/volume1/docker/stirling/config` | `/configs` | bind | Configuration files |
| `/volume1/docker/stirling/logs` | `/logs` | bind | Log files |
| `/volume1/docker/stirling/customfiles` | `/customFiles` | bind | Data storage |
| `/volume1/docker/stirling/pipeline` | `/pipeline` | bind | Data storage |


## 🌐 Access Information

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

### 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**: `timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8080' || exit 1`
**Check Interval**: 10s
**Timeout**: 5s
**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 stirling-pdf

# Restart service
docker-compose restart stirling-pdf

# Update service
docker-compose pull stirling-pdf
docker-compose up -d stirling-pdf

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for stirling-pdf
- **Docker Hub**: [docker.stirlingpdf.com/stirlingtools/stirling-pdf](https://hub.docker.com/r/docker.stirlingpdf.com/stirlingtools/stirling-pdf)
- **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/stirlingpdf.yml`
