Skip to content

Whitelabel Quick Start Guide

Get your branded version of Slidefactory running in 5 minutes.

Quick Setup (3 Steps)

1. Prepare Your Logos

You need two logo files:

  • Small logo (navigation/chat): Square or circular, 64-128px, PNG format
  • Large logo (login page): Banner format, max 80px height, PNG format

2. Place Logo Files

Put your logos in the static directory:

# Option A: Use default paths (easiest)
cp your-small-logo.png static/img/logo.png
cp your-large-logo.png static/img/logo_large.png

# Option B: Use custom subdirectory
mkdir -p static/img/clients/yourcompany/
cp your-small-logo.png static/img/clients/yourcompany/logo.png
cp your-large-logo.png static/img/clients/yourcompany/logo_large.png

3. Set Environment Variables

Add to your .env file or environment:

# Required
CLIENT_NAME="Your Company Name"
CLIENT_PRIMARY_COLOR="#yourcolor"  # Your brand color (hex format)

# Optional (if using custom paths)
CLIENT_LOGO=/static/img/clients/yourcompany/logo.png
CLIENT_LOGO_LARGE=/static/img/clients/yourcompany/logo_large.png

Done! Restart the application and your branding is live.

Examples

Example 1: Minimal Setup

# .env
CLIENT_NAME=Acme Corp
CLIENT_PRIMARY_COLOR=#007ACC
Place logos at static/img/logo.png and static/img/logo_large.png

Example 2: Full Customization

# .env
CLIENT_NAME=Global Solutions
CLIENT_LOGO=/static/img/clients/global/logo.png
CLIENT_LOGO_LARGE=/static/img/clients/global/banner.png
CLIENT_PRIMARY_COLOR=#2ECC71
CLIENT_DESCRIPTION=Global Solutions Presentation Platform

Verify It Works

  1. Start the app: 

    ./start.sh

  2. Check configuration: 

    python3 -c "from app.config import settings; print(settings.CLIENT_NAME)"

  3. Visit pages:

  4. Login: http://localhost:8080/auth/signin
  5. API Docs: http://localhost:8080/docs

  6. Manifest: http://localhost:8080/manifest.json

  7. Verify:

  8. ✅ Your logo appears in navigation
  9. ✅ Your brand color is applied to buttons
  10. ✅ Your company name shows in browser title

Troubleshooting

Logo not showing? - Check file exists: ls -lh static/img/logo.png - Verify path in browser: http://localhost:8080/static/img/logo.png - Check Docker mount if using containers

Color not changing? - Hard refresh browser: Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (Mac) - Verify hex format includes # prefix - Check browser console for errors

Still using default branding? - Verify environment variables: env | grep CLIENT_ - Restart application after changes - Check .env file is in correct directory

Docker Deployment

Docker Compose

services:
  web:
    environment:
      - CLIENT_NAME=Your Company
      - CLIENT_PRIMARY_COLOR=#007ACC
    volumes:
      - ./branding/logo.png:/app/static/img/logo.png:ro
      - ./branding/logo_large.png:/app/static/img/logo_large.png:ro

Azure Container Apps

az containerapp update \
  --name slidefactory \
  --set-env-vars \
    CLIENT_NAME="Your Company" \
    CLIENT_PRIMARY_COLOR="#007ACC"

Then update container image with your logo files included.

Need More?

That's it! Your branded Slidefactory is ready to use.