# Synapse Db

**🟢 Other Service**

## 📋 Service Overview

| Property | Value |
|----------|-------|
| **Service Name** | synapse-db |
| **Host** | Chicago_vm |
| **Category** | Other |
| **Difficulty** | 🟢 |
| **Docker Image** | `postgres` |
| **Compose File** | `Chicago_vm/matrix.yml` |
| **Directory** | `Chicago_vm` |

## 🎯 Purpose

synapse-db 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 (Chicago_vm)

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

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f synapse-db
```

## 🔧 Configuration

### Docker Compose Configuration
```yaml
container_name: Synapse-DB
environment:
- POSTGRES_DB=synapsedb
- POSTGRES_USER=synapseuser
- POSTGRES_PASSWORD="REDACTED_PASSWORD"
- POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=C --lc-ctype=C
healthcheck:
  interval: 10s
  retries: 10
  test:
  - CMD
  - pg_isready
  - -q
  - -d
  - synapsedb
  - -U
  - synapseuser
  timeout: 45s
hostname: synapse-db
image: postgres
restart: always
security_opt:
- no-new-privileges:true
volumes:
- /root/docker/db//var/lib/postgresql/data

```

### Environment Variables
| Variable | Value | Description |
|----------|-------|-------------|
| `POSTGRES_DB` | `synapsedb` | Configuration variable |
| `POSTGRES_USER` | `synapseuser` | Configuration variable |
| `POSTGRES_PASSWORD` | `***MASKED***` | PostgreSQL password |
| `POSTGRES_INITDB_ARGS` | `--encoding=UTF-8 --lc-collate=C --lc-ctype=C` | Configuration variable |


### Port Mappings
No ports exposed.

### Volume Mappings
| Host Path | Container Path | Type | Purpose |
|-----------|----------------|------|----------|
| `/root/docker/db//var/lib/postgresql/data` | `/root/docker/db//var/lib/postgresql/data` | volume | Data storage |


## 🌐 Access Information

This service does not expose any web interfaces.

## 🔒 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**: `CMD pg_isready -q -d synapsedb -U synapseuser`
**Check Interval**: 10s
**Timeout**: 45s
**Retries**: 10

### 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 synapse-db

# Restart service
docker-compose restart synapse-db

# Update service
docker-compose pull synapse-db
docker-compose up -d synapse-db

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

## 📚 Additional Resources

- **Official Documentation**: Check the official docs for synapse-db
- **Docker Hub**: [Official synapse-db](https://hub.docker.com/_/postgres)
- **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 Chicago_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**: `Chicago_vm/matrix.yml`