Files
homelab-optimized/docs/services/individual/mattermost-db.md
Gitea Mirror Bot ac5a4ca940
Some checks failed
Documentation / Build Docusaurus (push) Failing after 5m3s
Documentation / Deploy to GitHub Pages (push) Has been skipped
Sanitized mirror from private repository - 2026-04-01 04:44:34 UTC
2026-04-01 04:44:34 +00:00

4.3 KiB

Mattermost Db

🟡 Communication Service

📋 Service Overview

Property Value
Service Name mattermost-db
Host homelab_vm
Category Communication
Difficulty 🟡
Docker Image postgres:17
Compose File homelab_vm/mattermost.yml
Directory homelab_vm

🎯 Purpose

Mattermost is an open-source, self-hostable online chat service with file sharing, search, and integrations.

🚀 Quick Start

Prerequisites

  • Docker and Docker Compose installed
  • Basic understanding of REDACTED_APP_PASSWORD
  • Access to the host system (homelab_vm)

Deployment

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

🔧 Configuration

Docker Compose Configuration

container_name: mattermost-db
environment:
  POSTGRES_DB: mattermost
  POSTGRES_PASSWORD: "REDACTED_PASSWORD"
  POSTGRES_USER: mattermostuser
  TZ: America/Los_Angeles
healthcheck:
  interval: 10s
  retries: 10
  test:
  - CMD
  - pg_isready
  - -q
  - -d
  - mattermost
  - -U
  - mattermostuser
  timeout: 5s
hostname: mattermost-db
image: postgres:17
restart: unless-stopped
security_opt:
- no-new-privileges:true
user: 0:0
volumes:
- /srv/mattermost/db:/var/lib/postgresql/data:rw

Environment Variables

Variable Value Description
POSTGRES_DB mattermost Configuration variable
POSTGRES_USER mattermostuser Configuration variable
POSTGRES_PASSWORD ***MASKED*** PostgreSQL password
TZ America/Los_Angeles Timezone setting

Port Mappings

No ports exposed.

Volume Mappings

Host Path Container Path Type Purpose
/srv/mattermost/db /var/lib/postgresql/data bind Application data

🌐 Access Information

This service does not expose any web interfaces.

🔒 Security Considerations

  • Security options configured
  • Non-root user configured

📊 Resource Requirements

No resource limits configured

  • Minimum RAM: 512MB
  • Recommended RAM: 1GB+
  • CPU: 1 core minimum
  • Storage: Varies by usage

Resource Monitoring

Monitor resource usage with:

docker stats

🔍 Health Monitoring

Health check configured Test Command: CMD pg_isready -q -d mattermost -U mattermostuser Check Interval: 10s Timeout: 5s Retries: 10

Manual Health Checks

# 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

# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f mattermost-db

# Restart service
docker-compose restart mattermost-db

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

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

📚 Additional Resources

  • Official Documentation: Check the official docs for mattermost-db
  • Docker Hub: Official mattermost-db
  • Community Forums: Search for community discussions and solutions
  • GitHub Issues: Check the project's GitHub for known issues

Other services in the communication 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/mattermost.yml