mirror of
https://github.com/Dispatcharr/Dispatcharr.git
synced 2026-07-18 00:55:50 +00:00
e217960500
Add support for authentication when connecting to external Redis instances in modular deployment mode. This enables secure Redis deployments using either password-only authentication (Redis <6) or username + password authentication (Redis 6+ ACL). Changes: - Add REDIS_PASSWORD and REDIS_USER environment variables - Implement URL encoding for special characters in passwords - Update all Redis connection points to support auth - Add comprehensive documentation and examples to docker-compose.yml - Maintains full backward compatibility (empty defaults = no auth) All authentication mechanisms have been fully tested including pasword-only authentication, Redis 6+ ACL authentication with username + password, volume-mounted configuration files, and special character handling. Existing deployments are not effected, authentication support is entirely opt-in using docker-compose. Also, acknowledging the fact that the docker-compose file for modular deployments has been getting out of hand with auth support, the docker-compose.yml file was re-formatted for better visibility in configuration. This seemed like a better way to go than mandating a .env file.
65 lines
2.3 KiB
Python
65 lines
2.3 KiB
Python
#!/usr/bin/env python
|
|
"""
|
|
Helper script to wait for Redis to be available before starting the application.
|
|
"""
|
|
|
|
import redis
|
|
import time
|
|
import os
|
|
import sys
|
|
import logging
|
|
|
|
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
|
|
logger = logging.getLogger(__name__)
|
|
|
|
def wait_for_redis(host='localhost', port=6379, db=0, password='', username='', max_retries=30, retry_interval=2):
|
|
"""Wait for Redis to become available"""
|
|
redis_client = None
|
|
retry_count = 0
|
|
|
|
logger.info(f"Waiting for Redis at {host}:{port}/{db}...")
|
|
|
|
while retry_count < max_retries:
|
|
try:
|
|
redis_client = redis.Redis(
|
|
host=host,
|
|
port=port,
|
|
db=db,
|
|
password=password if password else None,
|
|
username=username if username else None,
|
|
socket_timeout=2,
|
|
socket_connect_timeout=2
|
|
)
|
|
redis_client.ping()
|
|
redis_client.flushdb() # Flush the database to ensure it's clean
|
|
logger.info(f"✅ Redis at {host}:{port}/{db} is now available!")
|
|
return True
|
|
except (redis.exceptions.ConnectionError, redis.exceptions.TimeoutError) as e:
|
|
retry_count += 1
|
|
if retry_count >= max_retries:
|
|
logger.error(f"❌ Failed to connect to Redis after {max_retries} attempts: {e}")
|
|
return False
|
|
|
|
logger.info(f"⏳ Redis not available yet, retrying in {retry_interval}s... ({retry_count}/{max_retries})")
|
|
time.sleep(retry_interval)
|
|
except Exception as e:
|
|
logger.error(f"❌ Unexpected error connecting to Redis: {e}")
|
|
return False
|
|
|
|
return False
|
|
|
|
if __name__ == "__main__":
|
|
host = os.environ.get('REDIS_HOST', 'localhost')
|
|
port = int(os.environ.get('REDIS_PORT', 6379))
|
|
db = int(os.environ.get('REDIS_DB', 0))
|
|
password = os.environ.get('REDIS_PASSWORD', '')
|
|
username = os.environ.get('REDIS_USER', '')
|
|
max_retries = int(os.environ.get('REDIS_WAIT_RETRIES', 30))
|
|
retry_interval = int(os.environ.get('REDIS_WAIT_INTERVAL', 2))
|
|
|
|
logger.info(f"Starting Redis availability check at {host}:{port}/{db}")
|
|
|
|
if wait_for_redis(host, port, db, password, username, max_retries, retry_interval):
|
|
sys.exit(0)
|
|
else:
|
|
sys.exit(1)
|