Wizarr Setup Guide - ajgillis04/GillisDockerDepot GitHub Wiki
Wizarr Setup Guide
Introduction
Wizarr is an invite management system for Plex servers. It helps you manage and send out invites to potential Plex users, allowing them to create their accounts and join your Plex server.
Prerequisites
- Docker installed
- Wizarr container running in your Docker stack
- Plex Media Server configured and running
Configuration Steps
Step 1: Accessing the Wizarr UI
- Open your browser and navigate to
http://<your-ip-address>:3000
. - Log in with your Wizarr credentials.
Step 2: Initial Setup Wizard
- Follow the initial setup wizard to configure basic settings.
- Enter your Plex server details, including the Plex token and server address.
Step 3: Configuring Invite Settings
- Navigate to the
Settings
tab. - Go to the
Invite Settings
section. - Customize the invite settings such as invite expiration time, default user roles, and welcome messages.
- Click
Save
.
Step 4: Creating Invite Links
- Navigate to the
Invites
tab. - Click
Create Invite
. - Enter the invite details (e.g., email address, role, expiration time).
- Click
Generate Invite Link
. - Share the invite link with the intended recipient.
Step 5: Managing Users
- Go to the
Users
tab. - View and manage the list of users who have accepted the invites and joined your Plex server.
- Edit user roles and permissions if necessary.
- Click
Save
.
Step 6: Customizing Settings
- Navigate to the
Settings
tab. - Customize additional settings such as notifications, appearance, and backup preferences.
- Click
Save
.
Notes
- Ensure all paths and environment variables are updated in the
wizarr.yaml
file. - Regularly backup your
config
directory to save your settings and invite data.
Troubleshooting
- Common Issues: List common issues and solutions.
- Logs: Check Wizarr logs for error messages.
- Support: Link to the Wizarr community and support resources.