Sanitized mirror from private repository - 2026-04-18 11:19:59 UTC

docs/services/individual/syncthing.md

@@ -0,0 +1,197 @@
+# Syncthing
+
+**🟢 Productivity Service**
+
+## 📋 Service Overview
+
+| Property | Value |
+|----------|-------|
+| **Service Name** | syncthing |
+| **Host** | homelab_vm |
+| **Category** | Productivity |
+| **Difficulty** | 🟢 |
+| **Docker Image** | `lscr.io/linuxserver/syncthing:latest` |
+| **Compose File** | `homelab_vm/syncthing.yml` |
+| **Directory** | `homelab_vm` |
+
+## 🎯 Purpose
+
+syncthing is a productivity application that helps manage tasks, documents, or workflows.
+
+## 🚀 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 syncthing
+```
+
+## 🔧 Configuration
+
+### Docker Compose Configuration
+```yaml
+container_name: syncthing
+environment:
+- PUID=1000
+- PGID=1000
+- TZ=America/Los_Angeles
+hostname: syncthing
+image: lscr.io/linuxserver/syncthing:latest
+ports:
+- 8384:8384
+- 22000:22000/tcp
+- 22000:22000/udp
+- 21027:21027/udp
+restart: always
+volumes:
+- /root/docker/syncthing/config:/config
+- /root/docker/syncthing/data1
+- /root/docker/syncthing/data2
+
+```
+
+### Environment Variables
+| Variable | Value | Description |
+|----------|-------|-------------|
+| `PUID` | `1000` | User ID for file permissions |
+| `PGID` | `1000` | Group ID for file permissions |
+| `TZ` | `America/Los_Angeles` | Timezone setting |
+
+
+### Port Mappings
+| Host Port | Container Port | Protocol | Purpose |
+|-----------|----------------|----------|----------|
+| 8384 | 8384 | TCP | Service port |
+| 22000 | 22000 | TCP | Service port |
+| 22000 | 22000 | UDP | Service port |
+| 21027 | 21027 | UDP | Service port |
+
+
+### Volume Mappings
+| Host Path | Container Path | Type | Purpose |
+|-----------|----------------|------|----------|
+| `/root/docker/syncthing/config` | `/config` | bind | Configuration files |
+| `/root/docker/syncthing/data1` | `/root/docker/syncthing/data1` | volume | Data storage |
+| `/root/docker/syncthing/data2` | `/root/docker/syncthing/data2` | volume | Data storage |
+
+
+## 🌐 Access Information
+
+Service ports: 8384:8384, 22000:22000/tcp, 22000:22000/udp, 21027:21027/udp
+
+## 🔒 Security Considerations
+
+- ⚠️ Consider adding security options (no-new-privileges)
+- ⚠️ 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 syncthing
+
+# Restart service
+docker-compose restart syncthing
+
+# Update service
+docker-compose pull syncthing
+docker-compose up -d syncthing
+
+# Access service shell
+docker-compose exec syncthing /bin/bash
+# or
+docker-compose exec syncthing /bin/sh
+```
+
+## 📚 Additional Resources
+
+- **Official Documentation**: Check the official docs for syncthing
+- **Docker Hub**: [lscr.io/linuxserver/syncthing:latest](https://hub.docker.com/r/lscr.io/linuxserver/syncthing:latest)
+- **Community Forums**: Search for community discussions and solutions
+- **GitHub Issues**: Check the project's GitHub for known issues
+
+## 🔗 Related Services
+
+Services REDACTED_APP_PASSWORD syncthing:
+- Nextcloud
+- Paperless-NGX
+- BookStack
+- Syncthing
+
+---
+
+*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/syncthing.yml`