mirror of
https://github.com/wizarrrr/wizarr.git
synced 2025-12-23 23:59:23 -05:00
d0df4c6d5d
Changes: - Pre/post invitation wizard phases - Phase-aware routing (/pre-wizard/*, /post-wizard/*) - Phase indicator badges (visual categorization) - Dynamic completion button behavior - Two-column admin layout with category drag-and-drop - Invite code management service - Enhanced wizard export/import - Comprehensive test coverage (17 new test files)
101 lines
3.5 KiB
Markdown
101 lines
3.5 KiB
Markdown
# Wizarr
|
||
> 🚀 **Development Relaunched:** We're excited to announce that **Wizarr is back in active development**!
|
||
<br></br>
|
||
<p align="center">
|
||
|
||
<img src="./app/static/wizarr-logo.png" height="200">
|
||
<p></p>
|
||
</p>
|
||
<br></br>
|
||
|
||
[](https://github.com/wizarrrr/wizarr)
|
||
[](https://github.com/wizarrrr/wizarr)
|
||
[](https://github.com/wizarrrr/wizarr)
|
||
[](https://discord.gg/NYxwcjCK9x)
|
||
|
||
|
||
---
|
||
|
||
Wizarr is an automatic user invitation and management system for Plex, Jellyfin, Emby, Audiobookshelf, Romm, Komga and Kavita.
|
||
Create a unique invite link and share it with users — they’ll be automatically added to your media server and guided through downloading apps, accessing request systems, and more!
|
||
|
||
**The problem**: Inviting your Friends/Family to your Plex server Is complicated and tedious. It's also a hard concept for them to get their head around.
|
||
|
||
**The solution**: Wizarr makes it easy to invite users to your server by simply sending them a link, and guides them through the process of getting set up.
|
||
|
||
---
|
||
|
||
## ✨ Major Features
|
||
|
||
- Automatic invitations for Plex, Jellyfin, Emby, AudiobookShelf, Komga, Kavita and Romm
|
||
- Secure, user-friendly invitation process
|
||
- Plug-and-play SSO support*
|
||
- Multi-tiered invitation access
|
||
- Time-limited membership options
|
||
- Pre-invite and post-invite wizard steps
|
||
- Setup guide for media apps (like Plex)
|
||
- Request system integration (Overseerr, Ombi, etc.)
|
||
- Discord invite support
|
||
- Fully customisable with your own HTML snippets
|
||
|
||
---
|
||
|
||
## 🚀 Getting Started
|
||
|
||
Check out our documentation for how to install and run Wizarr:
|
||
|
||
📚 https://docs.wizarr.dev/getting-started/installation
|
||
|
||
## 🔧 API Documentation
|
||
|
||
Wizarr provides a comprehensive REST API for automation and integration with **automatic OpenAPI/Swagger documentation**:
|
||
|
||
📖 **Interactive API Documentation**: `http://your-wizarr-instance/api/docs/`
|
||
📋 **OpenAPI Specification**: `http://your-wizarr-instance/api/swagger.json`
|
||
|
||
---
|
||
|
||
## Sponsorship
|
||
Thank you to our sponsor for supporting Wizarr development!
|
||
|
||
<a href="https://elfhosted.com">
|
||
<img src="https://store.elfhosted.com/wp-content/uploads/2024/11/logo.svg" height="50" alt="Elfhosted" />
|
||
</a>
|
||
<a href="https://www.kwickflix.tv">
|
||
<img src=".github/sponsors/kwickflix.tv.png" height="50" alt="kwickflix.tv" />
|
||
</a>
|
||
|
||
|
||
---
|
||
|
||
## 🌍 Translations
|
||
|
||
We use Weblate to make Wizarr accessible in many languages.
|
||
Want to help translate? Click below!
|
||
|
||
<a href="https://hosted.weblate.org/engage/wizarr/">
|
||
<img src="https://hosted.weblate.org/widget/wizarr/wizarr-universal/287x66-grey.png" alt="Translation status" />
|
||
</a>
|
||
|
||
---
|
||
|
||
## ❤️ Thank You
|
||
|
||
A big thank you to these amazing contributors who’ve helped build and maintain this project:
|
||
|
||
<a href="https://github.com/wizarrrr/wizarr/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=wizarrrr/wizarr" />
|
||
</a>
|
||
|
||
---
|
||
|
||
## 📸 Screenshots
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|