Skip to content

Commit

Permalink
Merge pull request #366 from wizarrrr/develop
Browse files Browse the repository at this point in the history
release: v4 beta 2
  • Loading branch information
JamsRepos authored Apr 18, 2024
2 parents 3a90b8d + 97116ee commit 9f41016
Show file tree
Hide file tree
Showing 41 changed files with 201 additions and 271 deletions.
96 changes: 40 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,93 +3,75 @@

---


<p align="center">
<img src="https://raw.githubusercontent.com/Wizarrrr/wizarr/master/apps/wizarr-frontend/src/assets/img/wizard.png" height="200">
<br/>
<br/>
<a href="https://github.com/wizarrrr/wizarr">
<img alt="GPL 2.0 License" src="https://img.shields.io/github/license/wizarrrr/wizarr.svg"/>
</a>
<a href="https://github.com/jellyfin/jellyfin/releases">
<img alt="Current Release" src="https://img.shields.io/github/release/wizarrrr/wizarr.svg"/>
</a>
<a href="https://hosted.weblate.org/engage/wizarr/">
<img src="https://hosted.weblate.org/widgets/wizarr/-/app/svg-badge.svg" />
</a>
<a href="https://opencollective.com/wizarr">
<img alt="Donate" src="https://img.shields.io/opencollective/all/wizarr.svg?label=backers"/>
</a>
<a href="https://features.wizarr.dev">
<img alt="Submit Feature Requests" src="https://img.shields.io/badge/vote_now-features?label=features"/>
</a>
<a href="https://discord.gg/XXCz7aM3ak">
<img alt="Chat on Discord" src="https://img.shields.io/discord/1020742926856372224"/>
</a>
<a href="https://www.reddit.com/r/wizarr">
<img alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fwizarr-%23FF5700.svg"/>
</a>
<a href="https://github.com/Wizarrrr/wizarr/issues">
<img alt="Github Issue" src="https://img.shields.io/github/issues/wizarrrr/wizarr"/>
</a>
<a href="https://features.wizarr.dev">
<img alt="Submit Feature Requests" src="https://img.shields.io/badge/fider-vote%20on%20features-success.svg"/>
</a>
<a href="https://github.com/Wizarrrr/wizarr/actions/workflows/release.yml">
<img alt="Github Build" src="https://img.shields.io/github/actions/workflow/status/wizarrrr/wizarr/release.yml"/>
</a>
<a href="https://github.com/wizarrrr/wizarr/blob/master/LICENSE.md"><img alt="GPL 2.0 License" src="https://img.shields.io/github/license/wizarrrr/wizarr.svg"/></a>
<a href="https://github.com/wizarrrr/wizarr/releases"><img alt="Current Release" src="https://img.shields.io/github/release/wizarrrr/wizarr.svg"/></a>
<a href="https://features.wizarr.dev" style="text-decoration: none"><img alt="Submit Feature Requests" src="https://img.shields.io/badge/vote_now-features?label=features"/></a>
<a href="https://discord.gg/XXCz7aM3ak"><img alt="Chat on Discord" src="https://img.shields.io/discord/1020742926856372224"/></a>
<a href="https://www.reddit.com/r/wizarr"><img alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fwizarr-%23FF5700.svg"/></a>
<a href="https://github.com/Wizarrrr/wizarr/issues"><img alt="Github Issue" src="https://img.shields.io/github/issues/wizarrrr/wizarr"/></a>
<a href="https://github.com/Wizarrrr/wizarr/actions/workflows/beta-ci.yml"><img alt="Github Build" src="https://img.shields.io/github/actions/workflow/status/wizarrrr/wizarr/beta-ci.yml"/></a>
</p>

---

# WIZARR NOTICE

Wizzar is back in development after the main developer Ash went MIA. Stay tuned for `4.0.0-beta.1` which will be the first release of the new development team. We are working hard to make Wizarr even better than before.
Wizzar is back in development! You can test the new beta using `ghcr.io/wizarrrr/wizarr:beta` as your image selection. We are working very hard to make Wizarr even better than before! :blush:

If you wish to stay up-to-date with our progress, make sure to join our [Discord](https://discord.gg/XXCz7aM3ak) server and check the `#beta-updates` channel.

---

## What is Wizarr?

Wizarr is a automatic user invitation system for Plex and Jellyfin. Create a unique link and share it to a user and they will be invited to your Media Server after they complete there signup proccess! They can even be guided to download the clients and read instructions on how to use your media software!

## What's the difference between V3 and V4?

V3 is the current stable version of Wizarr, it is a fully functional system that allows you to invite users to your media server. V4 is the next version of Wizarr that is currently in development (curently the exact same as `3.5.1-beta.7`). There's not much diffrence between the two versions, V4 will involve a refactoring of the codebase and a few new features. V4 will be the first version of Wizarr that is developed by the new development team.
Wizarr is an automated user invitation system for Plex/Jellyfin/Emby. You can create a unique link, share it with a user, and they will be invited to your Media Server after they complete the simple signup process!

## Major Features Include

- Automatic Invitation to your Media Server (Plex, Jellyfin)
- Automatic Invitation System to your Media Server (Plex/Jellyfin/Emby)
- Support for Passkey authentication for Admin Users
- Create multiple invitations with different configurations
- Make invitations and users expire after a certain amount of time
- Automatically add users to your Request System (Ombi, Jellyseerr, Overseerr)
- Add users to your Discord Server
- Create a custom HTML page
- Automatically add users to your Requesting System (Jellyseerr/Overseerr)
- Invite users to your Discord server through the onboarding process
- Multi-Language Support
- Scheduled Tasks to keep Wizarr updated with your Media Server
- Live logs directly from the Wizarr Web UI
- Multiple Admin Users with different permissions
- Notification System
- API for Developers with Swagger UI
- Light and Dark Mode Support
- Session Management for Admin Users
- Scheduled Tasks to keep Wizarr updated with your Media Server
- Live logs directly from the Wizarr Web UI

## What is the difference between V3 and V4?

V3 is the current stable version of Wizarr; It is a fully functional system that allows you to invite users to your Plex/Jellyfin/Emby media server. V4 is the next iteration which will expand on features considerably. For now, however, a few changes have already been added:

## Whats to come
- Administrator password change
- Linking and unlinking your Discord server to/from the onboarding process
- Updated logo and branding

## Major features to come in V4 will include

- Added API Endpoints
- Custom onboarding builder
- Added API Endpoints (already partially available)
- Plex/Jellyfin/Emby granular user permissions
- Discord invite request integration
- Multi-Server Support
- Mass Emailing to Client Users
- SMTP Support for notifications and user invites
- OAuth Support with custom providers
- Use your own Database
- 2FA Support for Admin Users
- Built in Update System
- Full Wizard Customization with Drag and Drop Template Editor
- Jellyfin and Plex user permissions management tool
- Invite Request System for users to request invite
- Plugin Store
- and much more!

## Getting Started

This version is the exact same as `3.5.1-beta.7` for now but we will be updating the codebase soon. You can install Wizarr by following the instructions below.
You can install the stable version of Wizarr by following the instructions below.

```
docker run -d \
Expand All @@ -114,17 +96,19 @@ services:

## Documentation

Any issues we welcome you to come onto our [Discord](https://discord.gg/XXCz7aM3ak) and ask for a member of staff, we would be happy to help.
Check out our documentation for instructions on how to install and run Wizarr!
[View Documentation](https://github.com/Wizarrrr/wizarr/blob/master/docs/setup/README.md).

If you want to help contribute to Wizarr by building V4's documentation we would really appreciate it, again join the [Discord](https://discord.gg/XXCz7aM3ak) and we can get you started.

~~Check out our documentation for instructions on how to install and run Wizarr!
[View Documentation](https://github.com/Wizarrrr/wizarr/blob/master/docs/setup/README.md)~~
If you encounter any issues please don't hesitate to visit our [Discord](https://discord.gg/XXCz7aM3ak) server and ask for help, we would be happy to help.

<a href="https://discord.gg/XXCz7aM3ak">
<img alt="Chat on Discord" src="https://img.shields.io/discord/1020742926856372224"/>
</a>

## Contributing

If you wish to contribute to our project you can check out our contributing guide [here](https://github.com/wizarrrr/wizarr/blob/develop/CONTRIBUTING.md).

## Thank you

A big thank you ❤️ to these amazing people for contributing to this project!
Expand Down
3 changes: 1 addition & 2 deletions apps/wizarr-frontend/.storybook/manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ addons.setConfig({
theme: create({
base: systemTheme,
brandTitle: "Wizarr",

colorPrimary: "#fe4155",
colorPrimary: "#e05362",
colorSecondary: "#4B5563",
}),
});
2 changes: 1 addition & 1 deletion apps/wizarr-frontend/config/VitePWA.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const VitePWAConfig: Partial<VitePWAOptions> = {
manifest: {
name: "Wizarr",
short_name: "Wizarr",
theme_color: "#ff4155",
theme_color: "#D03143",
background_color: "#111827",
orientation: "portrait",
display: "standalone",
Expand Down
Loading

0 comments on commit 9f41016

Please sign in to comment.