a better way to manage your Jellyfin users, now in go
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Harvey Tindall 85536ff79e
expand CONTRIBUTING, print if tray enabled on startup
4 years ago
.github add other funding method 4 years ago
common remove dependency on common from mediabrowser 4 years ago
config Discord: Add option to provide server invite 4 years ago
css Discord: Add option to provide server invite 4 years ago
docs use esbuild to compile and minify ts 4 years ago
html Discord: Add option to provide server invite 4 years ago
images add missing perms, fix order 4 years ago
lang Merge Discord branch 4 years ago
logger refactor; move logger to module 4 years ago
mail fix broken url in welcome email 4 years ago
ombi ombi: reset password when using pwr links 4 years ago
scripts fix generate_ini for multiline descriptions 4 years ago
static Merge a17t-redesign, kinda ts-ify setup.js 4 years ago
ts Discord: Add option to provide server invite 4 years ago
.drone.yml change notray/tray naming, add deb/rpm/apk 4 years ago
.gitignore Telegram: add language files 4 years ago
.goreleaser.yml expand CONTRIBUTING, print if tray enabled on startup 4 years ago
CONTRIBUTING.md expand CONTRIBUTING, print if tray enabled on startup 4 years ago
Dockerfile use build constraints for embed, clean up makefile 4 years ago
LICENSE update license date 4 years ago
Makefile Discord: Try to avoid more race conditions 4 years ago
README.md Mention TrayIcon deps in README 4 years ago
api.go Discord: Add option to provide server invite 4 years ago
args.go refactor; move logger to module 4 years ago
auth.go use different color library, wrap logger functions with it 4 years ago
autostart.go fix cross compilation in goreleaser/drone 4 years ago
config.go add email notify enable/disable; remove (de)hyphening 4 years ago
daemon.go implement user expiry functionality 4 years ago
discord.go Discord: Try to avoid more race conditions 4 years ago
email.go add email notify enable/disable; remove (de)hyphening 4 years ago
external.go use build constraints for embed, clean up makefile 4 years ago
go.mod expand CONTRIBUTING, print if tray enabled on startup 4 years ago
go.sum expand CONTRIBUTING, print if tray enabled on startup 4 years ago
internal.go almost complete telegram user verification 4 years ago
jfa-go.service fix dropdown colors in dark mode on chrome 4 years ago
lang.go almost complete telegram user verification 4 years ago
main.go expand CONTRIBUTING, print if tray enabled on startup 4 years ago
models.go Discord: Add option to provide server invite 4 years ago
notray.go add basic tray functionality 4 years ago
package-lock.json Bump lodash from 4.17.20 to 4.17.21 4 years ago
package.json Bump lodash from 4.17.20 to 4.17.21 4 years ago
pwreset.go Telegram: Send messages via telegram 4 years ago
pwval.go live validation on form, change special character definition 4 years ago
restart.go add hard restart for updates on *nix 4 years ago
restart_windows.go add hard restart for updates on *nix 4 years ago
router.go Discord: Add option to provide server invite 4 years ago
setup.go Split some settings into new "messages" section 4 years ago
static.go use embed.fs wrapper on data 4 years ago
storage.go Discord: Display channel on account creation form 4 years ago
stripmd.go Discord: Remove extra newlines around links 4 years ago
telegram.go Merge Discord branch 4 years ago
template.go Fix email editor for other email types 4 years ago
tray.go fix cross compilation in goreleaser/drone 4 years ago
updater.go expand CONTRIBUTING, print if tray enabled on startup 4 years ago
userdaemon.go Split some settings into new "messages" section 4 years ago
views.go Discord: Add option to provide server invite 4 years ago

README.md

jfa-go Build Status Docker Hub Translation status

Downloads:
dockerhub | stable | nightly | aur stable | aur binary | aur nightly

jfa-go is a user management app for Jellyfin (and now Emby) that provides invite-based account creation as well as other features that make one's instance much easier to manage.

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 profiles: Assign settings profiles to invites so new users have your predefined permissions, homescreen layout, etc. applied to their account on creation.
    • Password validation: Ensure users choose a strong password.
  • User expiry: Specify a validity period, and new users accounts will be disabled/deleted after it. The period can be manually extended too.
  • 🔗 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.
  • Telegram & Discord Integration: Verify users via a Telegram or Discord bot, and send Password Resets, Announcements, etc. through it.
  • 📨 Email storage: Add your existing users 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 users 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/telegram.
  • Notifications: Get notified when someone creates an account, or an invite expires.
  • 📣 Announcements: Bulk message your users with announcements about your server.
  • 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
  • 🌓 Customizations
    • Customize emails with variables and markdown
    • Specify contact and help messages to appear in emails and pages
    • Light and dark themes available

Interface

Invites tab Accounts tab Accounts creation

Install

The Docker image is your best bet.

docker create \
             --name "jfa-go" \ # Whatever you want to name it
             -p 8056:8056 \
            # -p 8057:8057 if using tls
             -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, ignore if using Emby
             -v /etc/localtime:/etc/localtime:ro \ # Makes sure time is correct
             hrfee/jfa-go # hrfee/jfa-go:unstable for latest build from git

TrayIcon builds include a tray icon to start/stop/restart, and an option to automatically start when you log-in to your computer. For Linux users, these builds depend on the libappindicator3-1/libappindicator-gtk3/libappindicator package for Debian/Ubuntu, Fedora, and Alpine respectively.

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

For other platforms, grab an archive from the release section for your platform (or nightly builds here), and extract the jfa-go executable to somewhere useful.

  • For *nix/macOS users, chmod +x jfa-go then place it somewhere in your PATH like /usr/bin.

Run the executable to start.

Build from source

If you're using docker, a Dockerfile is provided that builds from source.

Otherwise, 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.

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.
  -swagger
    	Enable swagger at /swagger/index.html

Systemd

jfa-go does not run as a daemon by default. Run jfa-go systemd to create a systemd .service file in your current directory, which you can copy into ~/.config/systemd/user or somewhere else.


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

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

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

Contributing

See CONTRIBUTING.md.

Translation

Translation status

For translations, use the weblate instance here. You can login with github.