191 lines
4.2 KiB
Markdown
191 lines
4.2 KiB
Markdown
# Synapse
|
|
|
|
**🟡 Other Service**
|
|
|
|
## 📋 Service Overview
|
|
|
|
| Property | Value |
|
|
|----------|-------|
|
|
| **Service Name** | synapse |
|
|
| **Host** | Chicago_vm |
|
|
| **Category** | Other |
|
|
| **Difficulty** | 🟡 |
|
|
| **Docker Image** | `matrixdotorg/synapse:latest` |
|
|
| **Compose File** | `Chicago_vm/matrix.yml` |
|
|
| **Directory** | `Chicago_vm` |
|
|
|
|
## 🎯 Purpose
|
|
|
|
Matrix Synapse is a reference homeserver implementation of the Matrix protocol.
|
|
|
|
## 🚀 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
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
### Docker Compose Configuration
|
|
```yaml
|
|
container_name: Synapse
|
|
depends_on:
|
|
synapse-db:
|
|
condition: service_started
|
|
environment:
|
|
- TZ=America/Los_Angeles
|
|
- SYNAPSE_CONFIG_PATH=/data/homeserver.yaml
|
|
hostname: synapse
|
|
image: matrixdotorg/synapse:latest
|
|
ports:
|
|
- 8500:8008/tcp
|
|
restart: always
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
volumes:
|
|
- /root/docker/data:/data
|
|
|
|
```
|
|
|
|
### Environment Variables
|
|
| Variable | Value | Description |
|
|
|----------|-------|-------------|
|
|
| `TZ` | `America/Los_Angeles` | Timezone setting |
|
|
| `SYNAPSE_CONFIG_PATH` | `/data/homeserver.yaml` | Configuration variable |
|
|
|
|
|
|
### Port Mappings
|
|
| Host Port | Container Port | Protocol | Purpose |
|
|
|-----------|----------------|----------|----------|
|
|
| 8500 | 8008 | TCP | Service port |
|
|
|
|
|
|
### Volume Mappings
|
|
| Host Path | Container Path | Type | Purpose |
|
|
|-----------|----------------|------|----------|
|
|
| `/root/docker/data` | `/data` | bind | Application data |
|
|
|
|
|
|
## 🌐 Access Information
|
|
|
|
Service ports: 8500:8008/tcp
|
|
|
|
## 🔒 Security Considerations
|
|
|
|
- ✅ Security options configured
|
|
- ⚠️ Consider running as non-root user
|
|
- 🔒 Enable HTTPS
|
|
- 🔒 Configure federation carefully
|
|
- 🔒 Regular database backups
|
|
- 🔒 Monitor resource usage
|
|
|
|
## 📊 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 synapse
|
|
|
|
# Restart service
|
|
docker-compose restart synapse
|
|
|
|
# Update service
|
|
docker-compose pull synapse
|
|
docker-compose up -d synapse
|
|
|
|
# Access service shell
|
|
docker-compose exec synapse /bin/bash
|
|
# or
|
|
docker-compose exec synapse /bin/sh
|
|
```
|
|
|
|
## 📚 Additional Resources
|
|
|
|
- **Official Documentation**: Check the official docs for synapse
|
|
- **Docker Hub**: [matrixdotorg/synapse:latest](https://hub.docker.com/r/matrixdotorg/synapse: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 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`
|