🔥SlideMaster3000: Streamlined Presentation Deployment

SlideMaster3000 is a solution for deploying Slidev presentations from GitHub, enabling seamless access through a web browser. This application eliminates common presentation challenges by providing a centralized, platform for slide management and distribution.

🚀 Overview

SlideMaster3000 addresses common challenges in presentation delivery by:

1. 📦 Retrieving Slidev presentations from a GitHub repository
2. 💻 Rendering them on a server using Streamlit
3. 🌐 Making them accessible via standard web browsers

This approach ensures consistent presentation experiences across different environments.

🐳 Docker Deployment

For simplified deployment with containerization:

Local Development (without Caddy)

# Clone the repository
git clone https://github.com/yourusername/slides_deployment.git
cd slides_deployment

# Configure authentication
mkdir secrets/
nano ./secrets/github_token # paste your personal github token here 
echo "your_password" > ./secrets/streamlit_passwords # place desired password(s) here
# hash password (to make it somehow secure)
python hash_password.py -f ./secrets/streamlit_passwords

# Set SLIDEV_HOST_URL in .env to http://localhost:3030/
# This is already the default in the provided .env file

# Deploy with Docker Compose
docker-compose up --build -d

Access the application at http://localhost:8502 after deployment.

Production Deployment (with Caddy)

# Clone the repository
git clone https://github.com/yourusername/slides_deployment.git
cd slides_deployment

# Configure authentication
mkdir secrets/
nano ./secrets/github_token # paste your personal github token here 
echo "your_password" > ./secrets/streamlit_passwords # place desired password(s) here
# hash password (to make it somehow secure)
python hash_password.py -f ./secrets/streamlit_passwords

# Configure for production
# Set SLIDEV_HOST_URL in .env to /slidev/
sed -i 's|SLIDEV_HOST_URL=http://localhost:3030/|SLIDEV_HOST_URL=/slidev/|' .env


# Configure Caddy (copy the provided Caddyfile to your Caddy config directory) (or use nano to modyfi accordingly)
sudo cp Caddyfile /etc/caddy/Caddyfile
sudo systemctl reload caddy

# Deploy with Docker Compose
docker-compose up --build -d

Access the application at your configured domain after deployment.

⚙️ Application Workflow

The application process:

1. 🔒 Authenticates users via password protection (unsecure)
2. 📇 Retrieves available presentations from GitHub
3. ⬇️ Downloads selected presentation content
4. 🖥️ Initializes a Slidev server for rendering
5. 🖼️ Presents content in a full-screen interface

🔧 Development Environment

For local development and customization:

📋 Prerequisites

• Python 3.12 or higher
• Node.js 18 or higher
• pnpm (for Slidev package management)
• GitHub repository containing Slidev presentations

🔨 Setup Process

1. Repository Setup:

   git clone https://github.com/yourusername/slides_deployment.git
   cd slides_deployment

2. Python Environment Configuration:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -r requirements.txt

3. Slidev Installation:

   cd slidev
   pnpm install
   cd ..

4. Authentication Configuration:

   mkdir -p secrets
   echo "your_github_token" > secrets/github_token
   
   # Generate hashed password
   python hash_password.py your_password
   # Add the output hash to secrets/streamlit_passwords
   
   # Or hash passwords from a file
   python hash_password.py -f password_list.txt
   # Then move the generated .hashed file
   mv password_list.txt.hashed secrets/streamlit_passwords

5. Application Launch:

   streamlit run slidev_viewer.py

6. Slidev Development:

   cd slidev
   pnpm dev  # Starts Slidev development server

📁 GitHub Repository Structure

The GitHub repository should follow this structure for compatibility:

slides-repo/
├── presentation1/
│   ├── slides.md       # Main Slidev file
│   └── assets/         # Images and other assets
│       ├── image1.png
│       └── image2.jpg
├── presentation2/
│   ├── slides.md
│   └── assets/
│       └── logo.svg
└── ...

SlideMaster3000 automatically detects folders containing a slides.md file and presents them as available presentations.

💡 Note

• Environment Configuration: The .env file contains the following settings:
  • STREAMLIT_PASSWORD_FILE: Path to the password file (default: ./secrets/streamlit_passwords)
  • GITHUB_TOKEN_FILE: Path to the GitHub token file (default: ./secrets/github_token)
  • GITHUB_USER: GitHub username that owns the slides repository (default: felixscode)
  • GITHUB_REPO: GitHub repository name containing the presentations (default: slides)
  • SLIDEV_HOST_URL: URL path where Slidev presentations will be served (default: /slidev/)
• Authentication Management:
  • Each line in secrets/streamlit_passwords should contain a SHA-256 hashed password (use the included hash_password.py utility to generate them)
  • Slidev presentations are protected with secure token-based authentication
  • Tokens are temporary (1 hour expiration) and tied to specific presentations
  • Users must authenticate through the Streamlit interface to receive valid tokens
• Static Build Architecture: The application:
  • Uses build_and_serve.sh script to build Slidev content with npx slidev build
  • Serves static files using a custom token-authenticated Python HTTP server
• Process Management: The application automatically:
  • Stops any process using port 3030 before starting a new presentation
  • Sets maximum wait time limits to prevent hanging on failed server startups
  • Manages token validation for all presentation access
• Reverse Proxy Setup: The provided Caddyfile configures a reverse proxy that:
  • Routes the main Streamlit application from your domain's root path
  • Routes the Slidev presentations through subdomain with secure token-based access
  • Eliminates the need to open additional ports in your firewall

❓ Frequently Asked Questions

Q: What advantages does SlideMaster3000 offer over Slidev's built-in hosting?
A: SlideMaster3000 provides authentication, centralized presentation management, and eliminates the need for multiple server instances.

Q: Is SlideMaster3000 suitable for enterprise presentations?
A: NO! As of now SlideMaster3000 is a 1. DAY build. Authentication is not secure and process management quite ambiguous

Q: Can the default port configuration be modified?
A: Yes, port configuration can be modified by updating the Slidev startup parameters and corresponding iframe URL.

📃 License

This software is available for use under standard MIT open-source terms.

✅ TODO

• add build caching
• add token sys for subdomain (slidev server)
• refactor code

---

Developed with ❤️ in the ⛰️ by Felix Schelling

🌐Personal Website
📄Heracless