1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-06-13 21:17:46 +02:00
a better way to manage your Jellyfin users, now in go.
Go to file
Harvey Tindall c4acb43cb8
Initial features for move to profiles
user templates will become profiles. You will be able to make multiple,
and assign them  to invites individually. This commit migrates the
separate template files into one profile entry called "Default", and
lets you select them on invites. No way to create profiles has been
added yet.
2020-09-20 11:21:04 +01:00
.github/ISSUE_TEMPLATE add issue template 2020-09-15 12:00:20 +01:00
config Initial features for move to profiles 2020-09-20 11:21:04 +01:00
data Initial features for move to profiles 2020-09-20 11:21:04 +01:00
images update readme; new images 2020-09-19 16:38:53 +01:00
mail Add account deletion with email notification 2020-09-17 23:50:07 +01:00
scss omit source map url in compiled css 2020-09-18 22:21:16 +01:00
.gitignore Remove view settings button 2020-09-18 22:06:28 +01:00
.goreleaser.yml fix goreleaser to include data subdirectories 2020-09-05 21:10:06 +01:00
api.go Initial features for move to profiles 2020-09-20 11:21:04 +01:00
auth.go cleaned up auth 2020-08-23 14:59:07 +01:00
config.go Initial features for move to profiles 2020-09-20 11:21:04 +01:00
daemon.go use app identifier instead of ctx 2020-08-16 13:36:54 +01:00
Dockerfile compress executable in dockerfile 2020-09-02 20:10:33 +01:00
email.go Add account deletion with email notification 2020-09-17 23:50:07 +01:00
go.mod Upgrade packages 2020-08-16 14:33:10 +01:00
go.sum Upgrade packages 2020-08-16 14:33:10 +01:00
jfa-go.service add example systemd service 2020-09-03 21:32:59 +01:00
jfapi.go Add account deletion with email notification 2020-09-17 23:50:07 +01:00
LICENSE Added install step to makefile; start PKGBUILD 2020-08-19 12:10:34 +01:00
main.go Initial features for move to profiles 2020-09-20 11:21:04 +01:00
Makefile version based on current tag for makefile 2020-09-15 12:12:51 +01:00
ombi.go add issue template 2020-09-15 12:00:20 +01:00
package-lock.json CLI flags, start setting up goreleaser, add build scripts 2020-08-01 21:20:02 +01:00
package.json CLI flags, start setting up goreleaser, add build scripts 2020-08-01 21:20:02 +01:00
pwreset.go userByName reloads cache if user not found, more things in test 2020-09-16 19:19:04 +01:00
pwval.go Partial check for invite page, 404 handling 2020-07-31 13:03:36 +01:00
README.md fix image links 2020-09-19 16:40:33 +01:00
setup.go use newJellyfin instead of constructor method 2020-08-30 20:44:10 +01:00
storage.go Initial features for move to profiles 2020-09-20 11:21:04 +01:00
version.py version based on current tag for makefile 2020-09-15 12:12:51 +01:00
views.go add user button 2020-09-18 00:59:59 +01:00

jfa-go

jfa-go is a user management app for 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 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.
  • 🔗 Ombi Integration: Automatically creates Ombi accounts for new users using their email address and login details, and your own defined set of permissions.
  • Account management: Apply settings to your users individually or en masse, and delete users, optionally sending them an email notification with a reason.
  • 📨 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

Invites tab Accounts tab

Install

Available on the AUR as jfa-go or jfa-go-git.

For other platforms, grab an archive from the release section for your platform, and extract jfa-go and data to the same directory.

  • For linux users, you can place them inside /opt/jfa-go and then run sudo ln -s /opt/jfa-go/jfa-go /usr/bin/jfa-go to place it in your PATH.

Run the executable to start.

For docker, run:

docker create \
             --name "jfa-go" \ # Whatever you want to name it
             -p 8056:8056 \
             -v /path/to/.config/jfa-go:/data \ # Path to wherever you want to store the config file and other data
             -v /path/to/jellyfin:/jf \ # Path to jellyfin config directory
             -v /etc/localtime:/etc/localtime:ro \ # Makes sure time is correct
             hrfee/jfa-go # hrfee/jfa-go:unstable for latest build from git

Build from source

A Dockerfile is provided that creates an image built from source, but it's only suitable for those who will run jfa-go in docker.

Full build instructions can be found here.

Usage

Simply run jfa-go to start the application. A setup wizard will start on localhost:8056 (or your own specified address). Upon completion, refresh the page.

Note: jfa-go does not run as a daemon by default. You'll need to figure this out yourself.

Usage of ./jfa-go:
  -config string
    	alternate path to config file. (default "~/.config/jfa-go/config.ini")
  -data string
    	alternate path to data directory. (default "~/.config/jfa-go")
  -debug
    	Enables debug logging and exposes pprof.
  -host string
    	alternate address to host web ui on.
  -port int
    	alternate port to host web ui on.

If you're switching from jellyfin-accounts, copy your existing ~/.jf-accounts to:

  • XDG_CONFIG_DIR/jfa-go (usually ~/.config) on *nix systems,
  • %AppData%/jfa-go on Windows,
  • ~/Library/Application Support/jfa-go on macOS.

(or specify config/data path with -config/-data respectively.)