# Companion

**🟢 Development Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | companion |
| **Host** | concord_nuc |
| **Category** | Development |
| **Difficulty** | 🟢 |
| **Docker Image** | `quay.io/invidious/invidious-companion:latest` |
| **Compose File** | `concord_nuc/invidious/invidious.yaml` |
| **Directory** | `concord_nuc/invidious` |

## 🎯 Purpose

companion is a development tool that assists with code management, CI/CD, or software development workflows.

## 🚀 Quick Start

### Prerequisites
- Docker and Docker Compose installed
- Basic understanding of REDACTED_APP_PASSWORD
- Access to the host system (concord_nuc)

### Deployment
```bash
# Navigate to service directory
cd concord_nuc/invidious

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f companion
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
cap_drop:
- ALL
environment:
- SERVER_SECRET_KEY=REDACTED_SECRET_KEY
image: quay.io/invidious/invidious-companion:latest
logging:
  options:
    max-file: '4'
    max-size: 1G
read_only: true
restart: unless-stopped
security_opt:
- no-new-privileges:true
volumes:
- companioncache:/var/tmp/youtubei.js:rw

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `SERVER_SECRET_KEY` | `***MASKED***` | Application secret key |


### Port Mappings
No ports exposed.

### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `companioncache` | `/var/tmp/youtubei.js` | volume | Temporary files |


## 🌐 Access Information

This service does not expose any web interfaces.

## 🔒 Security Considerations

- ✅ Security options configured
- ⚠️ Consider running as non-root user
- ✅ Read-only root filesystem
- ✅ Capabilities dropped

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

# Restart service
docker-compose restart companion

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

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for companion
- **Docker Hub**: [quay.io/invidious/invidious-companion:latest](https://hub.docker.com/r/quay.io/invidious/invidious-companion: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 companion:
- GitLab
- Gitea
- Jenkins
- Portainer

---

*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**: `concord_nuc/invidious/invidious.yaml`
