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 6f0f6e6901
ci: switch deb repo address
4 months ago
.github
.woodpecker ci: switch deb repo address 4 months ago
common
config userpage: make it clearer access control settings dont apply to it 11 months ago
css trim base css of most redundant classes 11 months ago
docs
easyproxy proxy: use for updater & SMTP 1 year ago
html ui: fix layout when userpage card not shown on login 11 months ago
images images: one more try 1 year ago
lang Translated using Weblate (German) 5 months ago
linecache
logger logs: fix file identifier 11 months ago
mail
ombi proxy: add http/socks5 support, use for Jellyfin 1 year ago
scripts build: increase goreleaser build timeout 4 months ago
site site: fix for new font 11 months ago
static
ts announce: URL encode/decode template labels 4 months ago
.drone.yml.old ci: migrate to woodpecker on arm64 4 months ago
.gitignore proxy: add http/socks5 support, use for Jellyfin 1 year ago
.goreleaser.yml goreleaser: support building on non-x86-64 host 4 months ago
CONTRIBUTING.md readme: cleanup and up-to-dateness 11 months ago
Dockerfile attempt 2 at BUILT_BY in Docker CI 4 months ago
LICENSE
Makefile pwr: include pwr-pin in build process, whoops 11 months ago
README.md readme: cleanup and up-to-dateness 11 months ago
api-activities.go ips: log on activities, show on card 11 months ago
api-backups.go backups: show uploaded backups on-page 11 months ago
api-invites.go invites: ui adjustments, fix duration display > 1y 11 months ago
api-messages.go ips: log on activities, show on card 11 months ago
api-ombi.go ombi: fix password reset on default route 1 year ago
api-profiles.go referrals: add "use expiry" option 1 year ago
api-userpage.go ips: log on activities, show on card 11 months ago
api-users.go announce: URL encode/decode template labels 4 months ago
api.go Merge branch 'main' into kimboslice99-main 11 months ago
args.go backups: add -restore cli argument 11 months ago
auth.go ips: log on activities, show on card 11 months ago
autostart.go
backups.go backups: show uploaded backups on-page 11 months ago
config.go logip: fix user logging 11 months ago
daemon.go pwr: add captcha daemon 11 months ago
discord.go discord: update profile list when changes occur 1 year ago
email.go userpage: allow manual disable of pwr through username/email/contact 11 months ago
exit.go
external.go
go.mod proxy: use for updater & SMTP 1 year ago
go.sum proxy: use for updater & SMTP 1 year ago
internal.go
jfa-go.service
lang.go setup: Include proxy, test JF with it 1 year ago
log.go
main.go tls: don't "crash" on server close 4 months ago
matrix.go
matrix_crypto.go
matrix_nocrypto.go
migrations.go
models.go Merge branch 'main' into kimboslice99-main 11 months ago
notray.go
package-lock.json tls: don't "crash" on server close 4 months ago
package.json node: update deps 1 year ago
pwreset.go
pwval.go
restart.go
restart_windows.go
router.go router: correctly use local FS for custom HTML 6 months ago
setup.go setup: Include proxy, test JF with it 1 year ago
static.go
storage.go ips: log on activities, show on card 11 months ago
stripmd.go
tailwind.config.js
telegram.go
template.go
tray.go
updater.go backups: add backup daemon to run every n minutes, keep x most recent backups 11 months ago
user-auth.go ips: log on activities, show on card 11 months ago
userdaemon.go ips: log on activities, show on card 11 months ago
views.go Merge branch 'main' into kimboslice99-main 11 months ago

README.md

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

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

Alternatives

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.

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

Interface

Invites tab Accounts creation My Account Page Accounts tab

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 \ # 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
Debian/Ubuntu
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
# ------
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.
  -restore string
    	path to database backup to restore.
  -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.

Contributing

See the wiki page.

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: