![Wizarr]()
Wizarr
Container
Wizarr is an advanced user invitation and management system for Jellyfin, Plex, Emby etc.
Image details
Source details
Configuration
TypeContainerghcr.io/wizarrrr/wizarr5690/tcp/data/database : /opt/mediadepot/apps/wizarr/etc/localtime : /etc/localtimeAPP_URL=https://wizarr.domain.comtraefik.enable=truetraefik.http.services.wizarr.loadbalancer.server.port=5690traefik.http.routers.wizarr.entrypoints=websecuretraefik.http.routers.wizarr.tls.certresolver=mydnschallengeTemplate by mediadepot
Standalone Install
Select an install method, to see config/commands for deploying Wizarr
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Wizarr, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation, or see wizarrrr/wizarr for app-specific guidance.
Wizarr
🚀 Development Relaunched: We're excited to announce that Wizarr is back in active development!
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.jsonSponsorship
Thank you to our sponsor for supporting Wizarr development!
🌍 Translations
We use Weblate to make Wizarr accessible in many languages.Want to help translate? Click below!
❤️ Thank You
A big thank you to these amazing contributors who’ve helped build and maintain this project:📸 Screenshots
Serve Wizarr on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying wizarr.example.com to http://wizarr:5690
Add this to your Caddyfile
wizarr.example.com {
reverse_proxy http://wizarr:5690
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs wizarr - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Published on a random port
This template exposes 5690/tcp without setting a host port,
so Docker picks a random free one on every deploy.
- Find it in the Ports column of Portainer's container list, or with
docker port wizarr
Permission denied on volumes
If the logs show "permission denied", the app can't write to its data folder on the host.
- Fix the ownership:
sudo chown -R 1000:1000 /opt/mediadepot/apps/wizarr - Seeing "read-only file system"?
/etc/localtimeis mounted read-only on purpose, the app isn't meant to write there.
Image won't pull
Test the pull directly on the host: docker pull ghcr.io/wizarrrr/wizarr
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on wizarrrr/wizarr
- Template not working: Open an issue on mediadepot/templates
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Wizarr runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Wizarr needs bundled into one download. This template pulls ghcr.io/wizarrrr/wizarr, which Docker fetches once (about 108 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Wizarr's comes from the GitHub Container Registry, published by wizarrrr.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:
5690, published on a random host port
Volumes
A volume is where Wizarr keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/data/databasefrom/opt/mediadepot/apps/wizarron the host/etc/localtimefrom/etc/localtimeon the host, read-only
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Wizarr takes 1 of them, all with defaults you can leave alone or tweak:
APP_URL, defaults tohttps://wizarr.domain.com
Networking
Nothing custom is set, so Wizarr sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container wizarr. That's what you'll spot in the containers list and use in commands like docker logs wizarr.
Labels
Labels are small notes pinned to the container. They don't change how Wizarr behaves, but other tools read them, most often a reverse proxy like Traefik working out which apps to route where. This template sets:
traefik.enable=truetraefik.http.services.wizarr.loadbalancer.server.port=5690traefik.http.routers.wizarr.entrypoints=websecuretraefik.http.routers.wizarr.tls.certresolver=mydnschallenge
Open source license
Wizarr is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Wizarr up. Add the template list to Portainer once, then deploying Wizarr is a click rather than a wall of config.