mirror of https://github.com/hrfee/jfa-go.git synced 2024-07-18 06:01:52 +02:00
a better way to manage your Jellyfin users, now in go.
Go to file
2024-07-14 00:32:25 +01:00
.github update version; mention log button in bug report template 2022-01-30 14:27:00 +00:00
common Show log on log.Fatal calls, provide "sanitized" version, fix goreleaser 2021-06-11 23:28:21 +01:00
config userpage: make it clearer access control settings dont apply to it 2023-12-28 13:47:45 +00:00
css trim base css of most redundant classes 2023-12-24 18:55:58 +00:00
docs use esbuild to compile and minify ts 2020-09-29 20:35:06 +01:00
easyproxy proxy: use for updater & SMTP 2023-10-05 12:32:25 +01:00
html ui: fix layout when userpage card not shown on login 2023-12-28 13:45:00 +00:00
images images: one more try 2023-09-08 17:46:58 +01:00
lang Translated using Weblate (German) 2024-07-05 02:47:06 +02:00
linecache Generate crash report txt and webpage 2021-06-11 21:56:53 +01:00
logger logs: fix file identifier 2023-12-20 18:28:42 +00:00
mail fix broken url in welcome email 2021-05-02 14:44:19 +01:00
ombi proxy: add http/socks5 support, use for Jellyfin 2023-10-05 11:25:58 +01:00
scripts userpage: generate & display referral links 2023-09-07 16:25:47 +01:00
site site: fix for new font 2023-12-26 14:36:13 +00:00
static font: switch to hanken grotesk 2023-06-23 13:45:04 +01:00
ts user: url split on pathname only 2024-07-13 14:22:05 +01:00
.drone.yml Fix deprecated georeleaser flag 2024-07-10 09:07:21 +02:00
.gitignore proxy: add http/socks5 support, use for Jellyfin 2023-10-05 11:25:58 +01:00
.goreleaser.yml goreleaser: increment version 2024-07-14 00:30:01 +01:00
api-activities.go ips: log on activities, show on card 2023-12-23 21:47:41 +00:00
api-backups.go backups: show uploaded backups on-page 2023-12-21 21:11:40 +00:00
api-invites.go invites: ui adjustments, fix duration display > 1y 2023-12-24 02:29:14 +00:00
api-messages.go ips: log on activities, show on card 2023-12-23 21:47:41 +00:00
api-ombi.go ombi: fix password reset on default route 2023-10-09 10:40:40 +01:00
api-profiles.go referrals: add "use expiry" option 2023-11-10 15:07:29 +00:00
api-userpage.go ips: log on activities, show on card 2023-12-23 21:47:41 +00:00
api-users.go Merge branch 'main' into kimboslice99-main 2023-12-23 21:53:39 +00:00
api.go Merge branch 'main' into kimboslice99-main 2023-12-23 21:53:39 +00:00
args.go backups: add -restore cli argument 2023-12-21 17:27:28 +00:00
auth.go ips: log on activities, show on card 2023-12-23 21:47:41 +00:00
autostart.go fix cross compilation in goreleaser/drone 2021-05-16 21:01:31 +01:00
backups.go backups: show uploaded backups on-page 2023-12-21 21:11:40 +00:00
config.go logip: fix user logging 2023-12-24 13:24:18 +00:00
CONTRIBUTING.md readme: cleanup and up-to-dateness 2023-12-28 14:24:21 +00:00
daemon.go pwr: add captcha daemon 2023-12-23 20:18:16 +00:00
discord.go discord: update profile list when changes occur 2023-10-11 12:00:38 +01:00
Dockerfile update node version in Dockerfile 2022-01-30 17:18:51 +00:00
email.go userpage: allow manual disable of pwr through username/email/contact 2023-12-20 18:18:39 +00:00
exit.go crash: render ANSI colors on crash page 2023-06-12 15:48:07 +01:00
external.go fix external fs 2021-07-16 15:39:22 +01:00
go.mod proxy: use for updater & SMTP 2023-10-05 12:32:25 +01:00
go.sum proxy: use for updater & SMTP 2023-10-05 12:32:25 +01:00
internal.go almost complete telegram user verification 2021-05-07 01:08:12 +01:00
jfa-go.service fix dropdown colors in dark mode on chrome 2021-03-09 18:15:14 +00:00
lang.go setup: Include proxy, test JF with it 2023-10-19 17:19:52 +01:00
LICENSE update license 2023-06-11 20:00:30 +01:00
log.go args: fix help not usually showing 2023-06-11 15:48:27 +01:00
main.go bump api version 2023-12-26 22:46:12 +00:00
Makefile pwr: include pwr-pin in build process, whoops 2023-12-20 18:40:18 +00:00
matrix_crypto.go matrix: fix instant crash with e2ee 2021-07-20 15:34:39 +01:00
matrix_nocrypto.go matrix: remove crypto dep in main file 2021-07-16 17:11:17 +01:00
matrix.go storage: start db migration (badger(hold)) 2023-06-24 17:05:04 +01:00
migrations.go profiles: fix application 2023-06-26 13:01:17 +01:00
models.go Merge branch 'main' into kimboslice99-main 2023-12-23 21:53:39 +00:00
notray.go tray: remove systray dep in non-tray builds 2021-08-18 17:25:16 +01:00
package-lock.json setup: Include proxy, test JF with it 2023-10-19 17:19:52 +01:00
package.json node: update deps 2023-09-08 18:21:09 +01:00
pwreset.go db: remove remaining storage.loadX calls 2023-06-25 20:18:40 +01:00
pwval.go live validation on form, change special character definition 2021-01-09 01:00:27 +00:00
README.md readme: cleanup and up-to-dateness 2023-12-28 14:24:21 +00:00
restart_windows.go add hard restart for updates on *nix 2021-05-03 20:08:23 +01:00
restart.go fix bugs with restarts/interrupts 2023-06-11 19:50:50 +01:00
router.go router: correctly use local FS for custom HTML 2024-05-26 18:08:48 +01:00
setup.go setup: Include proxy, test JF with it 2023-10-19 17:19:52 +01:00
static.go use embed.fs wrapper on data 2021-02-12 14:35:16 +00:00
storage.go ips: log on activities, show on card 2023-12-23 21:47:41 +00:00
stripmd.go Discord: Remove extra newlines around links 2021-05-23 01:05:53 +01:00
tailwind.config.js css: add notification animation 2023-06-26 20:13:02 +01:00
telegram.go db: migrate invites, user expiry 2023-06-24 19:13:05 +01:00
template.go Fix email editor for other email types 2021-04-22 19:16:41 +01:00
tray.go fix bugs with restarts/interrupts 2023-06-11 19:50:50 +01:00
updater.go backups: add backup daemon to run every n minutes, keep x most recent backups 2023-12-21 13:03:16 +00:00
user-auth.go ips: log on activities, show on card 2023-12-23 21:47:41 +00:00
userdaemon.go ips: log on activities, show on card 2023-12-23 21:47:41 +00:00
views.go Merge branch 'main' into kimboslice99-main 2023-12-23 21:53:39 +00:00

jfa-go Build Status Docker Hub Translation status Docs/Wiki Discord

docker | debian/ubuntu | arch (aur) | other platforms

Project Status: Active-ish

Studies mean I can't work on this project a lot outside of breaks, however I hope i'll be able to fit in general support and things like bug fixes into my time. New features and such will likely come in short bursts throughout the year (if they do at all).

Does/Will it still work?

jfa-go currently works on Jellyfin 10.8.13, the latest version as of 26/12/23. I should be able to maintain compatability in the future, unless any big changes occur.


If you want a bit more of a guarantee of support, I've seen these projects mentioned although haven't tried them myself.

  • Wizarr focuses on invites, and also includes some Discord & Ombi integration.
  • Jellyseerr is a fork of Overseerr, which can manage users and mainly acts as an Ombi alternative.
  • Organizr doesn't focus on Jellyfin, but allows putting self-hosted services into "tabs" on a central page, and allows creating users, which lets one control who can access what.

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


  • 🧑 Invite based account creation: Send 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, discord, telegram or matrix
    • 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.
    • CAPTCHAs and contact method verificatoin can be enabled to avoid bots.
  • 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. See wiki for a warning on this one.
  • Account management: Bulk or individually; apply settings, delete, disable/enable, send messages and much more.
  • 📣 Announcements: Bulk message your users with announcements about your server.
  • Telegram/Discord/Matrix Integration: Verify users via a chat bot, and send Password Resets, Announcements, etc. through it.
  • "My Account" Page: Allows users to reset their password, manage contact details, view their account expiry date, and send referrals. Can be customized with markdown.
  • Referrals: Users can be given special invites to send to their friends and families, similar to some invite-only services like Bluesky.
  • 🔑 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 them via email/telegram.
    • Can also be done through the "My Account" page if enabled.
  • Admin Notifications: Get notified when someone creates an account, or an invite expires.
  • 🌓 Customizations
    • Customize emails with variables and markdown
    • Specify contact and help messages to appear in emails and pages
    • Light and dark themes available


Invites tab Accounts creation My Account Page Accounts tab


Note: 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.

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 \ # Only needed for password resets through Jellyfin, ignore if not using or 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
sudo apt-get update && sudo apt-get install curl apt-transport-https gnupg
curl https://apt.hrfee.dev/hrfee.pubkey.gpg | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/apt.hrfee.dev.gpg

# For stable releases
echo "deb https://apt.hrfee.dev trusty main" | sudo tee /etc/apt/sources.list.d/hrfee.list
# ------
# For unstable releases
echo "deb https://apt.hrfee.dev trusty-unstable main" | sudo tee /etc/apt/sources.list.d/hrfee.list
# ------

sudo apt-get update

# For servers
sudo apt-get install jfa-go
# ------
# For desktops/servers with GUI (has dependencies)
sudo apt-get install jfa-go-tray
# ------

Available on the AUR as:

Other platforms

Download precompiled binaries from:

unzip the jfa-go/jfa-go.exe 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.


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:
	start jfa-go as a daemon and run in the background.
	stop a daemonized instance of jfa-go.
	generate a systemd .service file.

  -config, -c string
    	alternate path to config file. (default "/home/hrfee/.config/jfa-go/config.ini")
  -data, -d string
    	alternate path to data directory. (default "/home/hrfee/.config/jfa-go")
    	Enables debug logging.
  -help, -h
    	prints this message.
  -host string
    	alternate address to host web ui on.
  -port, -p int
    	alternate port to host web ui on.
    	Exposes pprof profiler on /debug/pprof.
  -restore string
    	path to database backup to restore.
    	Enable swagger at /swagger/index.html


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.


See the wiki page.


Translation status

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


Big thanks to those who sponsor me. You can see them below: