a better way to manage your Jellyfin users, now in go.
Go to file
Harvey Tindall cee5489da6
typo
2020-08-19 15:53:06 +01:00
config Add debug flag; warning label for debug mode 2020-08-19 14:09:48 +01:00
data typo 2020-08-19 15:53:06 +01:00
images convert text to path to fix rendering on mobile 2020-08-02 13:16:43 +01:00
mail added -y option to prebuild scripts using node_bin 2020-08-16 14:39:47 +01:00
scss added -y option to prebuild scripts using node_bin 2020-08-16 14:39:47 +01:00
.gitignore Added makefile 2020-08-03 18:00:54 +01:00
.goreleaser.yml Disable i386 builds 2020-08-16 14:55:39 +01:00
Dockerfile Shrunk dockerfile 2020-08-17 11:32:34 +01:00
LICENSE Added install step to makefile; start PKGBUILD 2020-08-19 12:10:34 +01:00
Makefile Added install step to makefile; start PKGBUILD 2020-08-19 12:10:34 +01:00
PKGBUILD bump PKGBUILD to 0.1.4 2020-08-19 15:40:32 +01:00
README.md mention placing inside /opt 2020-08-19 12:31:16 +01:00
api.go use app identifier instead of ctx 2020-08-16 13:36:54 +01:00
auth.go provide error message on login and display it nicely 2020-08-19 14:50:16 +01:00
config.go use app identifier instead of ctx 2020-08-16 13:36:54 +01:00
daemon.go use app identifier instead of ctx 2020-08-16 13:36:54 +01:00
email.go use app identifier instead of ctx 2020-08-16 13:36:54 +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
jfapi.go added user caching with 30m timeout 2020-08-16 16:08:37 +01:00
main.go create new css link to smoothly transition between themes 2020-08-19 14:31:41 +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 use app identifier instead of ctx 2020-08-16 13:36:54 +01:00
pwval.go Partial check for invite page, 404 handling 2020-07-31 13:03:36 +01:00
setup.go use app identifier instead of ctx 2020-08-16 13:36:54 +01:00
storage.go CLI flags, start setting up goreleaser, add build scripts 2020-08-01 21:20:02 +01:00
views.go use app identifier instead of ctx 2020-08-16 13:36:54 +01:00

README.md

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.
  • 📨 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

Admin page Account creation page

Install

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.

A PKGBUILD is also provided for those using Arch Linux.

For docker, run:

docker create \
             --name "jfa-go" \ # Whatever you want to name it
             -p 8056:8056 \
             -v /path/to/.config/jfa-go:/data \ # Equivalent of ~/.jf-accounts
             -v /path/to/jellyfin:/jf \ # Path to jellyfin config directory
             -v /etc/localtime:/etc/localtime:ro \ # Makes sure time is correct
             hrfee/jfa-go

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")
  -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.)