Wizarr Documentation

Wizarr provides several automation and integration features for media server management:

• Automatic Invitations: Automates the process for Plex, Jellyfin, Emby, and other media servers.
• Secured Environment: Provides a secure space for the invitation process.
• SSO Support: Plug and Play Single Sign-On support.
• Multi-tiered Invitations: Supports complex invitation structures.
• Membership Duration: Allows setting specific durations for user memberships.
• Client Guidance: Guides users through downloading the appropriate Plex client.
• Requests Integration: Guides users on how to request content via software like Overseerr or Ombi.
• Discord Integration: Automatically invites users to your Discord server.
• Customization: Supports adding custom HTML for branding or specific needs.

Audiobookshelf is a self-hosted audiobook and podcast server used to share audio collections. When you are granted access to an Audiobookshelf server, you can:

• Access a constantly updated library of audiobooks and podcasts.
• Listen to content on-demand or download files for offline listening.
• Sync and track your listening progress across multiple devices.

Komga is an open-source media server used to host and manage digital comic, manga, and book libraries. Users invited to a Komga server can:

• Access a collection of comics and manga.
• Read content directly in a web browser.
• Download files for offline reading on various devices.
• Automatically track reading progress.
• Access multiple file formats including CBZ, CBR, PDF, and EPUB.

The Wizarr wizard uses a two-phase flow to manage user onboarding. This separation allows for different authentication requirements and user contexts:

1. Pre-Invite Phase (/pre-wizard):

   • Used before a user accepts an invitation.
   • Does not require authentication (relies on an invite code in the session).
   • Validates the invite code on every request.
   • Typically used for Terms of Service, requirements, or welcome messages.
   • Completes by redirecting to the join page.

2. Post-Invite Phase (/post-wizard):

   • Used after a user has accepted an invitation.
   • Requires authentication or a wizard_access session.
   • Typically used for app setup, library selection, or feature tours.
   • Completes by redirecting to a completion page.

To use Nginx Proxy Manager, add a new proxy host with these specific settings:

Details

• Domain Names: Your desired external hostname (e.g., wizarr.example.com)
• Scheme: http
• Forward Hostname / IP: Internal Wizarr hostname or IP
• Forward Port: 5690
• Cache Assets: yes
• Block Common Exploits: no

SSL

• SSL Certificate: Select an option (e.g., "Request a new SSL Certificate")
• Force SSL: yes
• HTTP/2 Support: yes

Wizarr provides automatic OpenAPI/Swagger documentation for its REST API. You can access the interactive Swagger UI and the OpenAPI specification directly from your running instance.

• Swagger UI: http://your-wizarr-instance/api/docs/ (for real-time testing and schema viewing)
• OpenAPI Spec: http://your-wizarr-instance/api/swagger.json (for programmatic access to the spec)

Komga supports a wide variety of comic and manga readers across different platforms. You can access your library using the following applications:

• Mobile: iOS (Panels, Chunky) and Android (Mihon/Tachiyomi, Komga Client).
• Desktop: Windows (CDisplayEx, YACReader) and macOS/Linux (YACReader).
• Tablets: Any iPad or Android tablet with a compatible comic reader app.
• Web App: Access your library directly in a web browser at your specific server_url.
• E-Readers: Use KOReader or any other OPDS-compatible readers.

All API endpoints require authentication via an API key passed in the X-API-Key header.

To generate a key:

1. Log into the Wizarr web interface.
2. Navigate to Settings → API Keys.
3. Click "Create API Key".
4. Copy the generated key immediately, as it is only shown once.

curl -H "X-API-Key: your_api_key_here" \
     http://your-wizarr-instance/api/status