Skip to content

chartmann1590/VowVault

Repository files navigation

VowVault - Wedding Photo Gallery

A beautiful, modern wedding photo gallery with advanced features including SSO authentication, PWA support, and comprehensive admin tools.

⚠️ Development Status

This project is under active development. While we strive for stability, some features may not work as expected or may have bugs. If you encounter issues that aren't already documented or fixed, please help us improve by reporting them.

🐛 Reporting Issues

If you find a bug or encounter a problem:

  1. Check existing issues first: Visit the GitHub Issues page to see if your problem has already been reported
  2. Create a new issue: If it's a new problem, click the "New Issue" button on the Issues page
  3. Provide details: Include:
    • What you were trying to do
    • What happened instead
    • Steps to reproduce the issue
    • Your system/environment details
    • Any error messages you saw

Your feedback helps make VowVault better for everyone! 🚀

✨ Features

📸 Photo Management

  • Drag & Drop Upload: Easy photo and video uploads

  • Auto-Organization: Automatic sorting by upload date

  • Like & Comment System: Interactive engagement features

  • Virtual Photobooth: Custom wedding-themed photo capture

  • Video Support: Full video upload and playback support

🔐 Security & Authentication

  • SSO Integration: Secure Single Sign-On with multiple providers
    • Google OAuth 2.0
    • Microsoft Azure AD
    • Okta
    • Custom OAuth providers
  • Enhanced Security: CSRF protection, timeout handling, secure sessions
  • Access Control: Email and domain-based authorization
  • Admin Key Fallback: Backup authentication method
  • Disabled by Default: SSO is disabled by default for security

📱 Progressive Web App

  • Installable: Add to home screen on mobile devices
  • Offline Support: Works without internet connection
  • Push Notifications: Real-time updates and alerts
  • Responsive Design: Optimized for all screen sizes

🎨 Interactive Features

  • Message Board: Share thoughts and memories with photos
  • Digital Guestbook: Digital signatures with photo attachments
  • QR Code Generation: Easy sharing and access
  • Slideshow Mode: Automatic photo presentation
  • Email Integration: Photo uploads via email

⚙️ Admin Dashboard

  • Comprehensive Statistics: Upload counts, engagement metrics
  • Content Moderation: Hide/show messages and comments
  • Batch Operations: Bulk download and management
  • System Monitoring: Performance and security logs
  • SSO Management: Complete SSO configuration interface
  • Timezone Support: View all dates/times in your local timezone
  • Timezone Settings: Configure admin timezone preferences

🖼️ Screenshots

Gallery Interface

Gallery View Beautiful photo gallery with modern design

Upload Interface

Upload Interface Drag-and-drop photo upload with progress tracking

Mobile Experience

Mobile Gallery Responsive design optimized for mobile devices

PWA Installation Progressive Web App installation prompt on mobile

Admin Dashboard

Admin Dashboard Comprehensive admin panel with statistics and management tools

PWA Debug Tools PWA debugging and troubleshooting tools

Interactive Features

Virtual Photobooth Virtual photobooth with custom wedding borders

Message Board Interactive message board with photo sharing

Guestbook Digital guestbook with photo attachments

🚀 Quick Start

Using Docker (Recommended)

git clone https://github.com/chartmann1590/VowVault.git
cd VowVault
docker-compose up -d

Manual Installation

git clone https://github.com/chartmann1590/VowVault.git
cd VowVault
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
python migration.py
python run.py

Access:

📚 Documentation

For detailed information, see our comprehensive documentation:

  • Features - Complete feature breakdown and capabilities
  • Installation Guide - Setup instructions and troubleshooting
  • SSO Setup - Configure secure admin authentication with enhanced security
  • Usage Guide - Step-by-step user instructions
  • PWA Guide - Progressive Web App setup and troubleshooting

🔧 Configuration

Security

  • Change the default admin key in app.py
  • Enable SSO authentication for enhanced security (disabled by default)
  • Set up HTTPS/SSL for production
  • Configure proper backup strategy
  • Review security best practices in SSO documentation

Environment Variables

Copy env.example to .env and configure:

  • Email settings for photo uploads
  • Immich server sync settings
  • Database configuration

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

The MIT License is a permissive license that allows for:

  • Commercial use
  • Modification
  • Distribution
  • Private use

While providing liability protection for the authors. See the full license text for complete terms.

🙏 Acknowledgments

  • Built with Flask
  • Icons by Feather Icons
  • PWA implementation with modern web standards
  • Beautiful design inspired by wedding aesthetics

Made with ❤️ for your special day

Created by Charles Hartmann

About

A simple Wedding Photo Album and Guestbook

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages