homelab-optimized/docs/services/individual/shlink-db.md

Shlink Db

🟢 Other Service

📋 Service Overview

Property	Value
Service Name	shlink-db
Host	homelab_vm
Category	Other
Difficulty	🟢
Docker Image	postgres
Compose File	homelab_vm/shlink.yml
Directory	homelab_vm

🎯 Purpose

shlink-db 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

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

🔧 Configuration

Docker Compose Configuration

container_name: Shlink-DB
environment:
  POSTGRES_DB: shlink
  POSTGRES_PASSWORD: "REDACTED_PASSWORD"
  POSTGRES_USER: shlinkuser
healthcheck:
  interval: 10s
  retries: 5
  test:
  - CMD
  - pg_isready
  - -q
  - -d
  - shlink
  - -U
  - shlinkuser
  timeout: 5s
hostname: shlink-db
image: postgres
restart: always
security_opt:
- no-new-privileges:true
user: 1000:1000
volumes:
- /home/homelab/docker/shlinkdb:/var/lib/postgresql/data

Environment Variables

Variable	Value	Description
POSTGRES_DB	shlink	Configuration variable
POSTGRES_USER	shlinkuser	Configuration variable
POSTGRES_PASSWORD	***MASKED***	PostgreSQL password

Port Mappings

No ports exposed.

Volume Mappings

Host Path	Container Path	Type	Purpose
/home/homelab/docker/shlinkdb	/var/lib/postgresql/data	bind	Application data

🌐 Access Information

This service does not expose any web interfaces.

🔒 Security Considerations

• ✅ Security options configured
• ✅ Non-root user configured

📊 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:

docker stats

🔍 Health Monitoring

✅ Health check configured Test Command: CMD pg_isready -q -d shlink -U shlinkuser Check Interval: 10s Timeout: 5s Retries: 5

Manual Health Checks

# 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

# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f shlink-db

# Restart service
docker-compose restart shlink-db

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

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

📚 Additional Resources

• Official Documentation: Check the official docs for shlink-db
• Docker Hub: Official shlink-db
• 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