# Shlink

**🟡 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | shlink |
| **Host** | homelab_vm |
| **Category** | Other |
| **Difficulty** | 🟡 |
| **Docker Image** | `shlinkio/shlink:stable` |
| **Compose File** | `homelab_vm/shlink.yml` |
| **Directory** | `homelab_vm` |

## 🎯 Purpose

shlink 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 (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 shlink
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: Shlink
depends_on:
  shlink-db:
    condition: service_started
environment:
- TIMEZONE=America/Los_Angeles
- INITIAL_API_KEY=REDACTED_API_KEY
- DB_DRIVER=postgres
- DB_NAME=shlink
- DB_USER=shlinkuser
- DB_PASSWORD="REDACTED_PASSWORD"
- DB_HOST=shlink-db
- DB_PORT=5432
- DEFAULT_DOMAIN=url.thevish.io
- IS_HTTPS_ENABLED=true
- GEOLITE_LICENSE_KEY="REDACTED_GEOLITE_KEY"
hostname: shlink
image: shlinkio/shlink:stable
ports:
- 8335:8080
restart: always
security_opt:
- no-new-privileges:true

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `TIMEZONE` | `America/Los_Angeles` | Configuration variable |
| `INITIAL_API_KEY` | `***MASKED***` | Configuration variable |
| `DB_DRIVER` | `postgres` | Configuration variable |
| `DB_NAME` | `shlink` | Configuration variable |
| `DB_USER` | `shlinkuser` | Configuration variable |
| `DB_PASSWORD` | `***MASKED***` | Configuration variable |
| `DB_HOST` | `shlink-db` | Configuration variable |
| `DB_PORT` | `5432` | Configuration variable |
| `DEFAULT_DOMAIN` | `url.thevish.io` | Service domain name |
| `IS_HTTPS_ENABLED` | `true` | Configuration variable |
| `GEOLITE_LICENSE_KEY` | `***MASKED***` | Configuration variable |


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


### Volume Mappings
No volumes mounted.

## 🌐 Access Information

### Web Interface
- **HTTP**: `http://homelab_vm:8335`

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

⚠️ 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 shlink

# Restart service
docker-compose restart shlink

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

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

## 📚 Additional Resources

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