homelab-optimized/docs/services/individual/netbox-redis.md

Netbox Redis

🟢 Storage Service

📋 Service Overview

Property	Value
Service Name	netbox-redis
Host	Atlantis
Category	Storage
Difficulty	🟢
Docker Image	redis
Compose File	Atlantis/netbox.yml
Directory	Atlantis

🎯 Purpose

netbox-redis is a storage solution that manages data persistence, backup, or file sharing.

🚀 Quick Start

Prerequisites

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

Deployment

# Navigate to service directory
cd Atlantis

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f netbox-redis

🔧 Configuration

Docker Compose Configuration

command:
- sh
- -c
- redis-server --appendonly yes --requirepass REDACTED_PASSWORD
container_name: NETBOX-REDIS
environment:
- REDIS_PASSWORD="REDACTED_PASSWORD"
healthcheck:
  test:
  - CMD-SHELL
  - redis-cli ping || exit 1
hostname: netbox-redis
image: redis
restart: always
user: 1026:100
volumes:
- /volume1/docker/netbox/redis:/data

Environment Variables

Variable	Value	Description
REDIS_PASSWORD	***MASKED***	Redis authentication password

Port Mappings

No ports exposed.

Volume Mappings

Host Path	Container Path	Type	Purpose
/volume1/docker/netbox/redis	/data	bind	Application data

🌐 Access Information

This service does not expose any web interfaces.

🔒 Security Considerations

• ⚠️ Consider adding security options (no-new-privileges)
• ✅ 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:

docker stats

🔍 Health Monitoring

✅ Health check configured Test Command: CMD-SHELL redis-cli ping || exit 1

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 netbox-redis

# Restart service
docker-compose restart netbox-redis

# Update service
docker-compose pull netbox-redis
docker-compose up -d netbox-redis

# Access service shell
docker-compose exec netbox-redis /bin/bash
# or
docker-compose exec netbox-redis /bin/sh

📚 Additional Resources

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

🔗 Related Services

Other services in the storage category on Atlantis

---

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: Atlantis/netbox.yml