# Matrix Conduit

**🟢 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | matrix-conduit |
| **Host** | anubis |
| **Category** | Other |
| **Difficulty** | 🟢 |
| **Docker Image** | `matrixconduit/matrix-conduit:latest` |
| **Compose File** | `anubis/conduit.yml` |
| **Directory** | `anubis` |

## 🎯 Purpose

matrix-conduit 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 (anubis)

### Deployment
```bash
# Navigate to service directory
cd anubis

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f matrix-conduit
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: Matrix-Conduit
environment:
- CONDUIT_SERVER_NAME=vishtestingserver
- CONDUIT_DATABASE_PATH=/var/lib/matrix-conduit/
- CONDUIT_DATABASE_BACKEND=rocksdb
- CONDUIT_PORT=6167
- CONDUIT_MAX_REQUEST_SIZE=20000000
- CONDUIT_ALLOW_REGISTRATION=true
- CONDUIT_ALLOW_FEDERATION=true
- CONDUIT_TRUSTED_SERVERS=["matrix.org"]
- CONDUIT_MAX_CONCURRENT_REQUESTS=250
- CONDUIT_ADDRESS=0.0.0.0
- CONDUIT_CONFIG=''
hostname: matrix-conduit
image: matrixconduit/matrix-conduit:latest
ports:
- 8455:6167
restart: always
security_opt:
- no-new-privileges:true
user: 1000:1000
volumes:
- /home/vish/docker/matrix-conduit/:/var/lib/matrix-conduit/

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `CONDUIT_SERVER_NAME` | `vishtestingserver` | Configuration variable |
| `CONDUIT_DATABASE_PATH` | `/var/lib/matrix-conduit/` | Configuration variable |
| `CONDUIT_DATABASE_BACKEND` | `rocksdb` | Configuration variable |
| `CONDUIT_PORT` | `6167` | Configuration variable |
| `CONDUIT_MAX_REQUEST_SIZE` | `20000000` | Configuration variable |
| `CONDUIT_ALLOW_REGISTRATION` | `true` | Configuration variable |
| `CONDUIT_ALLOW_FEDERATION` | `true` | Configuration variable |
| `CONDUIT_TRUSTED_SERVERS` | `["matrix.org"]` | Configuration variable |
| `CONDUIT_MAX_CONCURRENT_REQUESTS` | `250` | Configuration variable |
| `CONDUIT_ADDRESS` | `0.0.0.0` | Configuration variable |
| `CONDUIT_CONFIG` | `''` | Configuration variable |


### Port Mappings
| Host Port | Container Port | Protocol | Purpose |
|-----------|----------------|----------|----------|
| 8455 | 6167 | TCP | Service port |


### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/home/vish/docker/matrix-conduit/` | `/var/lib/matrix-conduit/` | bind | Service data |


## 🌐 Access Information

Service ports: 8455:6167

## 🔒 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:
```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 matrix-conduit

# Restart service
docker-compose restart matrix-conduit

# Update service
docker-compose pull matrix-conduit
docker-compose up -d matrix-conduit

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for matrix-conduit
- **Docker Hub**: [matrixconduit/matrix-conduit:latest](https://hub.docker.com/r/matrixconduit/matrix-conduit:latest)
- **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 anubis

---

*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**: `anubis/conduit.yml`