Compare commits

..

1 Commits

Author SHA1 Message Date
ي
b93a4d2a67 docs: add podcast demo mode deployment flag guidance 2026-03-30 07:41:46 +05:30
2 changed files with 192 additions and 172 deletions

View File

@@ -48,8 +48,6 @@ load_dotenv(backend_dir / '.env') # backend/.env
load_dotenv(project_root / '.env') # root .env (fallback) load_dotenv(project_root / '.env') # root .env (fallback)
load_dotenv() # CWD .env (fallback) load_dotenv() # CWD .env (fallback)
PODCAST_ONLY_DEMO_MODE = os.getenv("PODCAST_ONLY_DEMO_MODE", "false").lower() in {"1", "true", "yes", "on"}
# Set up clean logging for end users # Set up clean logging for end users
from logging_config import setup_clean_logging from logging_config import setup_clean_logging
setup_clean_logging() setup_clean_logging()
@@ -112,8 +110,7 @@ from services.startup_health import (
# Import OAuth token monitoring routes # Import OAuth token monitoring routes
from api.oauth_token_monitoring_routes import router as oauth_token_monitoring_router from api.oauth_token_monitoring_routes import router as oauth_token_monitoring_router
if not PODCAST_ONLY_DEMO_MODE: # Import SEO Dashboard endpoints
# Import SEO Dashboard endpoints only when non-demo features are enabled
from api.seo_dashboard import ( from api.seo_dashboard import (
get_seo_dashboard_data, get_seo_dashboard_data,
get_seo_health_score, get_seo_health_score,
@@ -262,17 +259,12 @@ async def onboarding_status():
return onboarding_manager.get_onboarding_status() return onboarding_manager.get_onboarding_status()
# Include routers using modular utilities # Include routers using modular utilities
if not PODCAST_ONLY_DEMO_MODE:
router_manager.include_core_routers() router_manager.include_core_routers()
router_manager.include_optional_routers() router_manager.include_optional_routers()
else:
logger.info("PODCAST_ONLY_DEMO_MODE enabled: including only podcast and subscription feature routers.")
app.include_router(subscription_router)
# Include assets serving router (must be mounted to serve generated images) # Include assets serving router (must be mounted to serve generated images)
app.include_router(assets_serving_router) app.include_router(assets_serving_router)
if not PODCAST_ONLY_DEMO_MODE:
# SEO Dashboard endpoints # SEO Dashboard endpoints
@app.get("/api/seo-dashboard/data") @app.get("/api/seo-dashboard/data")
async def seo_dashboard_data(): async def seo_dashboard_data():
@@ -340,6 +332,8 @@ if not PODCAST_ONLY_DEMO_MODE:
"""Refresh analytics data by invalidating cache and fetching fresh data.""" """Refresh analytics data by invalidating cache and fetching fresh data."""
return await refresh_analytics_data(current_user, site_url) return await refresh_analytics_data(current_user, site_url)
@app.get("/api/seo-dashboard/onboarding-task-health") @app.get("/api/seo-dashboard/onboarding-task-health")
async def onboarding_task_health_endpoint(current_user: dict = Depends(get_current_user), site_url: str = None): async def onboarding_task_health_endpoint(current_user: dict = Depends(get_current_user), site_url: str = None):
"""Get consolidated health for onboarding-scheduled SEO tasks.""" """Get consolidated health for onboarding-scheduled SEO tasks."""
@@ -353,17 +347,31 @@ if not PODCAST_ONLY_DEMO_MODE:
# Phase 2B: Semantic health monitoring endpoint (24-hour polling) # Phase 2B: Semantic health monitoring endpoint (24-hour polling)
@app.get("/api/seo-dashboard/semantic-health") @app.get("/api/seo-dashboard/semantic-health")
async def semantic_health_endpoint(current_user: dict = Depends(get_current_user)): async def semantic_health_endpoint(current_user: dict = Depends(get_current_user)):
"""Get real-time semantic health metrics for content and competitors.""" """
Get real-time semantic health metrics for content and competitors.
This endpoint provides Phase 2B semantic intelligence monitoring data.
Returns semantic health score, status, and recommendations.
Data is cached and updated every 24 hours via scheduler.
"""
return await get_semantic_health(current_user) return await get_semantic_health(current_user)
@app.get("/api/seo-dashboard/cache-stats") @app.get("/api/seo-dashboard/cache-stats")
async def semantic_cache_stats_endpoint(current_user: dict = Depends(get_current_user)): async def semantic_cache_stats_endpoint(current_user: dict = Depends(get_current_user)):
"""Get semantic cache performance statistics.""" """
Get semantic cache performance statistics.
Returns hit rate, memory usage, and eviction counts.
"""
return await get_semantic_cache_stats(current_user) return await get_semantic_cache_stats(current_user)
@app.get("/api/seo-dashboard/sif-health") @app.get("/api/seo-dashboard/sif-health")
async def sif_indexing_health_endpoint(current_user: dict = Depends(get_current_user)): async def sif_indexing_health_endpoint(current_user: dict = Depends(get_current_user)):
"""Get SIF indexing health summary for the current user.""" """
Get SIF indexing health summary for the current user.
Used by the Semantic Indexing Status widget on the dashboard.
"""
return await get_sif_indexing_health(current_user) return await get_sif_indexing_health(current_user)
# Comprehensive SEO Analysis endpoints # Comprehensive SEO Analysis endpoints
@@ -416,7 +424,6 @@ if not PODCAST_ONLY_DEMO_MODE:
from api.podcast.router import router as podcast_router from api.podcast.router import router as podcast_router
app.include_router(podcast_router) app.include_router(podcast_router)
if not PODCAST_ONLY_DEMO_MODE:
# Include YouTube Creator Studio router # Include YouTube Creator Studio router
from api.youtube.router import router as youtube_router from api.youtube.router import router as youtube_router
app.include_router(youtube_router, prefix="/api") app.include_router(youtube_router, prefix="/api")

View File

@@ -105,8 +105,21 @@ JWT_SECRET_KEY=your_jwt_secret_key
# Monitoring # Monitoring
SENTRY_DSN=your_sentry_dsn SENTRY_DSN=your_sentry_dsn
# Podcast demo-mode switch (temporary testing flag)
# Enable demo-only podcast behavior:
PODCAST_ONLY_DEMO_MODE=true
# Full restore to normal behavior:
# PODCAST_ONLY_DEMO_MODE=false
# (or leave PODCAST_ONLY_DEMO_MODE unset)
``` ```
### Release Checklist (Demo-Mode Safety)
Before finalizing a release after demo testing, confirm:
- [ ] `PODCAST_ONLY_DEMO_MODE` is unset (or explicitly `false`) in production deployment config.
**Security Best Practices** **Security Best Practices**
- **Use Environment Variables**: Never hardcode sensitive data - **Use Environment Variables**: Never hardcode sensitive data
- **Rotate Keys Regularly**: Change API keys periodically - **Rotate Keys Regularly**: Change API keys periodically