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 2310130e6b
api clients: return data, error, no status
4 months ago
.github
.woodpecker ci: full clone for valid rev-list 4 months ago
common api clients: return data, error, no status 4 months ago
config expiry: add option to delete after n days 4 months ago
css web: css adjustments 4 months ago
docs
easyproxy proxy: use for updater & SMTP 1 year ago
html api clients: return data, error, no status 4 months ago
images users: huge cleanup/dedupe, interface-based third-party services 4 months ago
jellyseerr api clients: return data, error, no status 4 months ago
lang lang: rename ckb.json 4 months ago
linecache Generate crash report txt and webpage 3 years ago
logger logs: fix file identifier 11 months ago
logmessages api clients: return data, error, no status 4 months ago
mail accounts: notify users of expiry adjustment 4 months ago
ombi api clients: return data, error, no status 4 months ago
scripts build: increase goreleaser build timeout 4 months ago
site web: css adjustments 4 months ago
static build: include latest banner automatically 4 months ago
ts settings: add loader, improve css a bit 4 months ago
.gitignore build: include latest banner automatically 4 months ago
.goreleaser.yml build: include latest banner automatically 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 api clients: return data, error, no status 4 months ago
README.md README: update supported version, mention jellyseerr, update ci link, 4 months ago
api-activities.go api clients: return data, error, no status 4 months ago
api-backups.go logmessages: finish up to api-users (alphabetically), refactor 4 months ago
api-invites.go logmessages: finish up to api-users (alphabetically), refactor 4 months ago
api-jellyseerr.go users: huge cleanup/dedupe, interface-based third-party services 4 months ago
api-messages.go users: huge cleanup/dedupe, interface-based third-party services 4 months ago
api-ombi.go api clients: return data, error, no status 4 months ago
api-profiles.go api clients: return data, error, no status 4 months ago
api-userpage.go api clients: return data, error, no status 4 months ago
api-users.go api clients: return data, error, no status 4 months ago
api.go api clients: return data, error, no status 4 months ago
args.go backups: add -restore cli argument 11 months ago
auth.go api clients: return data, error, no status 4 months ago
autostart.go
backups.go logmessages: all log strings in one file 4 months ago
config.go logmessages: all log strings in one file 4 months ago
discord.go discord: option to add/remove role on enable/disable/deletion 4 months ago
email.go api clients: return data, error, no status 4 months ago
exit.go
external.go
generic-d.go logmessages: all log strings in one file 4 months ago
go.mod api clients: return data, error, no status 4 months ago
go.sum api clients: return data, error, no status 4 months ago
housekeeping-d.go api clients: return data, error, no status 4 months ago
internal.go
jellyseerr-d.go api clients: return data, error, no status 4 months ago
jfa-go.service
lang.go setup: add jellyseer, reference wiki for PWR 4 months ago
log.go
main.go api clients: return data, error, no status 4 months ago
matrix.go users: huge cleanup/dedupe, interface-based third-party services 4 months ago
matrix_crypto.go logmessages: all log strings in one file 4 months ago
matrix_nocrypto.go
migrations.go api clients: return data, error, no status 4 months ago
models.go users: huge cleanup/dedupe, interface-based third-party services 4 months ago
notray.go
package-lock.json css: fix inv creation card width on mobile 4 months ago
package.json
pwreset.go api clients: return data, error, no status 4 months ago
pwval.go
restart.go
restart_windows.go logmessages: all log strings in one file 4 months ago
router.go users: huge cleanup/dedupe, interface-based third-party services 4 months ago
setup.go api clients: return data, error, no status 4 months ago
static.go
storage.go expiry: add option to delete after n days 4 months ago
stripmd.go
tailwind.config.js
telegram.go users: huge cleanup/dedupe, interface-based third-party services 4 months ago
template.go
tray.go
updater.go logmessages: all log strings in one file 4 months ago
user-auth.go logmessages: all log strings in one file 4 months ago
user-d.go api clients: return data, error, no status 4 months ago
users.go api clients: return data, error, no status 4 months ago
views.go api clients: return data, error, no status 4 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.9.8, the latest version as of 31/07/2024. 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.


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/Jellyseerr Integration: Automatically creates and synchronizes details for new accounts. Supports setting permissions with the Profiles feature. Ombi integration use is risky, see wiki.
  • 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: