Giter Club home page Giter Club logo

wizarr's Introduction

Wizarr

Attention! Wizarr is still under development, you may experience issues.

Wizarr is a automatic user invitation system for Plex. Create a unique link and share it to a user and they will automatically be invited to your Plex Server! They will even be guided to download the Plex client and instructions on how to use your requests software!

Discord

Join Our Discord Server

alt

Major Features Include

  • Automatic Invitation to your Plex Server
  • Secured invitation environment
  • Plug and Play SSO Support*
  • Guide user on how to download Plex client
  • (Optional!) Requests Integration: Guide users on how to request Movies (Overseerr, Ombi...)

Planned features

  • Discord Bot Integration
  • jellyfin support
  • Multilingual Support

A note on SSO (Authelia, Authentik, etc)

As mentionned in the features, Wizarr supports SSO via disabling its inbuilt authentication! Attention! While setting up Wizarr, you will still be asked for a username and password, but these will be ignored if you enabled DISABLE_BUILTIN_AUTH To Setup, protect the Wizarr App with your SSO provider using Authelia for example or in the case of Authentik, using a Proxy Provider. However, make sure to whitelist the following paths, or users will not be able to join!

  • /join
  • /j/*
  • /setup*
  • /static/*

Installation

Docker Compose (recommended)

  1. Download Docker-compose file
version: "3.8"
services:
  wizarr:
    container_name: wizarr
    image: ghcr.io/wizarrrr/wizarr
    #image: ghcr.io/wizarrrr/wizarr:arm64 #For Arm64
    ports:
    - 5690:5690
    volumes:
      - ./data:/data/database
    environment:
      - APP_URL=https://join.domain.com
      - DISABLE_BUILTIN_AUTH=false #Set to true ONLY if you are using another auth provider (Authelia, Authentik, etc)
      - ALLOW_BUG_REPORTING=#true #Helps me fix bugs, but you can disable it if you want! I use Sentry.io for this.

  watchtower: #Optional but recommended, as Wizarr is still in development and will be updated frequently
    image: containrrr/watchtower
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    command: wizarr --interval 30
  1. Important Edit Variables

    APP_URL: Public Facing Url of your Wizarr instance DISABLE_BUILTIN_AUTH: Set to true if you want to disable the built in authentication and use SSO instead

  2. Run docker compose up -d or for older Docekr versions: docker-compose up -d

  3. Access WebUI at http://localhost:5690 and setup your Plex Server

Changelog

View Changelog by clicking here

Translations

In the process of adding a Translation system for the community to help translate Wizarr

Screenshots

These may be out of date

Light Mode

alt alt alt alt alt

Dark Mode

alt alt alt alt

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.