Sanitized mirror from private repository - 2026-04-19 08:46:29 UTC
This commit is contained in:
171
docs/services/individual/drawio.md
Normal file
171
docs/services/individual/drawio.md
Normal file
@@ -0,0 +1,171 @@
|
||||
# Drawio
|
||||
|
||||
**🟢 Other Service**
|
||||
|
||||
## 📋 Service Overview
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Service Name** | drawio |
|
||||
| **Host** | homelab_vm |
|
||||
| **Category** | Other |
|
||||
| **Difficulty** | 🟢 |
|
||||
| **Docker Image** | `jgraph/drawio` |
|
||||
| **Compose File** | `homelab_vm/drawio.yml` |
|
||||
| **Directory** | `homelab_vm` |
|
||||
|
||||
## 🎯 Purpose
|
||||
|
||||
drawio 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 drawio
|
||||
```
|
||||
|
||||
## 🔧 Configuration
|
||||
|
||||
### Docker Compose Configuration
|
||||
```yaml
|
||||
container_name: Draw.io
|
||||
cpu_shares: 768
|
||||
healthcheck:
|
||||
test: curl -f http://localhost:8080/ || exit 1
|
||||
image: jgraph/drawio
|
||||
mem_limit: 4g
|
||||
ports:
|
||||
- 5022:8080
|
||||
restart: on-failure:5
|
||||
security_opt:
|
||||
- no-new-privileges:true
|
||||
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
No environment variables configured.
|
||||
|
||||
### Port Mappings
|
||||
| Host Port | Container Port | Protocol | Purpose |
|
||||
|-----------|----------------|----------|----------|
|
||||
| 5022 | 8080 | TCP | Alternative HTTP port |
|
||||
|
||||
|
||||
### Volume Mappings
|
||||
No volumes mounted.
|
||||
|
||||
## 🌐 Access Information
|
||||
|
||||
### Web Interface
|
||||
- **HTTP**: `http://homelab_vm:5022`
|
||||
|
||||
### 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**: `curl -f http://localhost:8080/ || 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 drawio
|
||||
|
||||
# Restart service
|
||||
docker-compose restart drawio
|
||||
|
||||
# Update service
|
||||
docker-compose pull drawio
|
||||
docker-compose up -d drawio
|
||||
|
||||
# Access service shell
|
||||
docker-compose exec drawio /bin/bash
|
||||
# or
|
||||
docker-compose exec drawio /bin/sh
|
||||
```
|
||||
|
||||
## 📚 Additional Resources
|
||||
|
||||
- **Official Documentation**: Check the official docs for drawio
|
||||
- **Docker Hub**: [jgraph/drawio](https://hub.docker.com/r/jgraph/drawio)
|
||||
- **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/drawio.yml`
|
||||
Reference in New Issue
Block a user