Skip to content

Latest commit

 

History

History
109 lines (82 loc) · 4.4 KB

README.md

File metadata and controls

109 lines (82 loc) · 4.4 KB
Raw

Wizarr

The Free Media Invitation System



GPL 2.0 License Current Release Submit Feature Requests Chat on Discord Join our Subreddit Github Issue Github Build

WIZARR NOTICE

Wizzar is back in development! You can test the new beta using ghcr.io/wizarrrr/wizarr:beta as your image selection. We are working very hard to make Wizarr even better than before! 😊

If you wish to stay up-to-date with our progress, make sure to join our Discord server and check the #releases channel.

What is Wizarr?

Wizarr is an automated user invitation system compatible with Plex, Jellyfin and Emby. You can create a unique link, share it with a user, and they will be invited to your Media Server after they complete the simple signup process!

Major Features Include

  • Automatic Invitation System to your Media Server (Plex/Jellyfin/Emby)
  • Support for Passkey authentication for Admin Users
  • Create multiple invitations with different configurations
  • Make invitations and users expire after a certain amount of time
  • Automatically add users to your Requesting System (Jellyseerr/Overseerr)
  • Invite users to your Discord server through the onboarding process
  • Multi-Language Support
  • Multiple Admin Users with different permissions
  • API for Developers with Swagger UI
  • Light and Dark Mode Support
  • Session Management for Admin Users
  • Scheduled Tasks to keep Wizarr updated with your Media Server
  • Live logs directly from the Wizarr Web UI

Major features to come in V4 will include

  • Customizable onboarding and branding
  • Added API Endpoints (already partially available)
  • Plex/Jellyfin/Emby granular user permissions/profiles
  • Discord invite request integration
  • Multi-Server Support
  • SMTP Support for notifications and user invites
  • OAuth Support with custom providers
  • 2FA Support for Admin Users
  • Built in Update System
  • Plugin Store
  • and much more!

Getting Started

You can install the stable version of Wizarr by following the instructions below.

docker run -d \
    --name wizarr \
    -p 5690:5690 \
    -v ./wizarr/database:/data/database \
    ghcr.io/wizarrrr/wizarr:latest

---
services:
  wizarr:
    container_name: wizarr
    image: ghcr.io/wizarrrr/wizarr:latest
    ports:
      - 5690:5690
    volumes:
      - ./wizarr/database:/data/database

Documentation

Check out our documentation for instructions on how to install and run Wizarr! View Documentation.

If you encounter any issues please don't hesitate to visit our Discord server and ask for help, we would be happy to help.

Chat on Discord

Contributing

If you wish to contribute to our project you can check out our contributing guide here.

Thank you

A big thank you ❤️ to these amazing people for contributing to this project!