diff --git a/README.md b/README.md index 6ebd517..08e5f8c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,35 @@ #  -A rewrite of [jellyfin-accounts](https://github.com/hrfee/jellyfin-accounts) in Go. It has feature parity with the Python version, but should be faster. +jfa-go is a user management app for [Jellyfin](https://github.com/jellyfin/jellyfin) that provides invite-based account creation as well as other features that make one's instance much easier to manage. + +I chose to rewrite the python [jellyfin-accounts](https://github.com/hrfee/jellyfin-accounts) in Go mainly as a learning experience, but also to slightly improve speeds and efficiency. + +#### Features +* 🧑 Invite based account creation: Sends invites to your friends or family, and let them choose their own username and password without relying on you. + * Send invites via a link and/or email + * Granular control over invites: Validity period as well as number of uses can be specified. + * Account defaults: Configure an example account to your liking, and its permissions, access rights and homescreen layout can be applied to all new users. + * Password validation: Ensure users choose a strong password. +* 📨 Email storage: Add your existing user's email addresses through the UI, and jfa-go will ask new users for them on account creation. + * Email addresses can optionally be used instead of usernames +* 🔑 Password resets: When user's forget their passwords and request a change in Jellyfin, jfa-go reads the PIN from the created file and sends it straight to the user via email. +* Notifications: Get notified when someone creates an account, or an invite expires. +* Authentication via Jellyfin: Instead of using separate credentials for jfa-go and Jellyfin, jfa-go can use it as the authentication provider. + * Enables the usage of jfa-go by multiple people +* 🌓 Customizable look + * Specify contact and help messages to appear in emails and pages + * Light and dark themes available + * Optionally provide custom CSS + +## Interface +
+
+
+
+
+