182 lines
4.2 KiB
Markdown
182 lines
4.2 KiB
Markdown
# Shlink Web
|
|
|
|
**🟡 Other Service**
|
|
|
|
## 📋 Service Overview
|
|
|
|
| Property | Value |
|
|
|----------|-------|
|
|
| **Service Name** | shlink-web |
|
|
| **Host** | homelab_vm |
|
|
| **Category** | Other |
|
|
| **Difficulty** | 🟡 |
|
|
| **Docker Image** | `shlinkio/shlink-web-client:stable` |
|
|
| **Compose File** | `homelab_vm/shlink.yml` |
|
|
| **Directory** | `homelab_vm` |
|
|
|
|
## 🎯 Purpose
|
|
|
|
shlink-web 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-web
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
### Docker Compose Configuration
|
|
```yaml
|
|
container_name: Shlink-WEB
|
|
depends_on:
|
|
- shlink
|
|
environment:
|
|
- SHLINK_SERVER_NAME=thevish
|
|
- SHLINK_SERVER_URL=https://url.thevish.io
|
|
- SHLINK_SERVER_API_KEY=REDACTED_API_KEY
|
|
healthcheck:
|
|
test: wget --no-verbose --tries=1 --spider http://localhost:80/ || exit 1
|
|
hostname: shlink-web
|
|
image: shlinkio/shlink-web-client:stable
|
|
ports:
|
|
- 8336:80
|
|
restart: always
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
|
|
```
|
|
|
|
### Environment Variables
|
|
| Variable | Value | Description |
|
|
|----------|-------|-------------|
|
|
| `SHLINK_SERVER_NAME` | `thevish` | Configuration variable |
|
|
| `SHLINK_SERVER_URL` | `https://url.thevish.io` | Configuration variable |
|
|
| `SHLINK_SERVER_API_KEY` | `***MASKED***` | Configuration variable |
|
|
|
|
|
|
### Port Mappings
|
|
| Host Port | Container Port | Protocol | Purpose |
|
|
|-----------|----------------|----------|----------|
|
|
| 8336 | 80 | TCP | HTTP web interface |
|
|
|
|
|
|
### Volume Mappings
|
|
No volumes mounted.
|
|
|
|
## 🌐 Access Information
|
|
|
|
### Web Interface
|
|
- **HTTP**: `http://homelab_vm:8336`
|
|
|
|
### 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:80/ || exit 1`
|
|
|
|
### 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-web
|
|
|
|
# Restart service
|
|
docker-compose restart shlink-web
|
|
|
|
# Update service
|
|
docker-compose pull shlink-web
|
|
docker-compose up -d shlink-web
|
|
|
|
# Access service shell
|
|
docker-compose exec shlink-web /bin/bash
|
|
# or
|
|
docker-compose exec shlink-web /bin/sh
|
|
```
|
|
|
|
## 📚 Additional Resources
|
|
|
|
- **Official Documentation**: Check the official docs for shlink-web
|
|
- **Docker Hub**: [shlinkio/shlink-web-client:stable](https://hub.docker.com/r/shlinkio/shlink-web-client: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`
|