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.
 
 
 
 
 
 
Harvey Tindall 4c3e310634
use go install for swag in goreleaser
8 months ago
.github update version; mention log button in bug report template 10 months ago
common Show log on log.Fatal calls, provide "sanitized" version, fix goreleaser 1 year ago
config discord: add/move to slash commands 10 months ago
css Merge pull request #191 from LubricantJam/main 10 months ago
docs use esbuild to compile and minify ts 2 years ago
html settings: better top button padding on mobile 10 months ago
images add discord link; new thumbnail variant 11 months ago
lang lowercase lang 8 months ago
linecache Generate crash report txt and webpage 1 year ago
logger fix NewEmptyLogger 1 year ago
mail fix broken url in welcome email 1 year ago
ombi fix discord/telegram linking with ombi 10 months ago
scripts add NOTEMPLATE env var to missing-colors.js 10 months ago
site add NOTEMPLATE env var to missing-colors.js 10 months ago
static Merge a17t-redesign, kinda ts-ify setup.js 1 year ago
ts setup: report errors when saving config 10 months ago
.drone.yml apidocs: re-version, set up for hosted ui 1 year ago
.gitignore site: use tailwind 11 months ago
.goreleaser.yml use go install for swag in goreleaser 8 months ago
CONTRIBUTING.md update contributing 1 year ago
Dockerfile update node version in Dockerfile 10 months ago
LICENSE matrix: end-to-end encryption by default 1 year ago
Makefile use go install for swag in goreleaser 8 months ago
README.md add discord link; new thumbnail variant 11 months ago
api-invites.go reorganise api, add "Connection refused" error in setup 8 months ago
api-messages.go reorganise api, add "Connection refused" error in setup 8 months ago
api-ombi.go reorganise api, add "Connection refused" error in setup 8 months ago
api-profiles.go reorganise api, add "Connection refused" error in setup 8 months ago
api-users.go reorganise api, add "Connection refused" error in setup 8 months ago
api.go reorganise api, add "Connection refused" error in setup 8 months ago
args.go refactor; move logger to module 1 year ago
auth.go accounts: allow giving individual users jfa-go access 10 months ago
autostart.go fix cross compilation in goreleaser/drone 1 year ago
config.go discord: add/move to slash commands 10 months ago
discord.go form: add captcha regen button 10 months ago
email.go remove debug print, add another 11 months ago
exit.go print error and include in txt log on crash; fix email migration 1 year ago
external.go fix external fs 1 year ago
go.mod use go install for swag in goreleaser 8 months ago
go.sum use go install for swag in goreleaser 8 months ago
internal.go almost complete telegram user verification 1 year ago
invdaemon.go Move all migrations to separate file 1 year ago
jfa-go.service fix dropdown colors in dark mode on chrome 1 year ago
lang.go Setup: add messages, set password via link 1 year ago
log.go print error if logging fails 11 months ago
main.go update version; mention log button in bug report template 10 months ago
matrix.go matrix: fix instant crash with e2ee 1 year ago
matrix_crypto.go matrix: fix instant crash with e2ee 1 year ago
matrix_nocrypto.go matrix: remove crypto dep in main file 1 year ago
migrations.go update version; mention log button in bug report template 10 months ago
models.go form: fix captcha 10 months ago
notray.go tray: remove systray dep in non-tray builds 1 year ago
package-lock.json remove unused nightwind dep 8 months ago
package.json remove unused nightwind dep 8 months ago
pwreset.go admin: add manual "Send Password reset" to accounts tab 1 year ago
pwval.go live validation on form, change special character definition 1 year ago
restart.go add hard restart for updates on *nix 1 year ago
restart_windows.go add hard restart for updates on *nix 1 year ago
router.go form: add CAPTCHAs 10 months ago
setup.go reorganise api, add "Connection refused" error in setup 8 months ago
static.go use embed.fs wrapper on data 1 year ago
storage.go form: add CAPTCHAs 10 months ago
stripmd.go Discord: Remove extra newlines around links 1 year ago
tailwind.config.js modal: change transition 10 months ago
telegram.go Matrix: Setup bot, add PIN verification 1 year ago
template.go Fix email editor for other email types 1 year ago
tray.go tray: remove systray dep in non-tray builds 1 year ago
updater.go updater: check build is ready 10 months ago
userdaemon.go Split some settings into new "messages" section 1 year ago
views.go form: fix mono text in discord linking modal 10 months ago

README.md

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

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

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.

a rewrite of jellyfin-accounts (original naming for both, ik 😂).

Features

  • 🧑 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
    • 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/Matrix Integration: Verify users via a chat 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

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
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
Debian/Ubuntu
sudo apt-get update && sudo apt-get install curl apt-transport-https gnupg
curl https://apt.hrfee.dev/hrfee.pubkey.gpg | sudo apt-key add -

# 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
# ------
Arch

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.

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:
  start
	start jfa-go as a daemon and run in the background.
  stop
	stop a daemonized instance of jfa-go.
  systemd
	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")
  -debug
    	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.
  -pprof
    	Exposes pprof profiler on /debug/pprof.
  -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.

Sponsors

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