1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-12-22 09:00:10 +00:00
a better way to manage your Jellyfin users, now in go.
Go to file
Harvey Tindall a13a72c626
admin: fix logout when url base is used
two tries are made, with and without the url base.
2023-06-26 20:28:20 +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 form: actually link to the my account page 2023-06-22 21:57:19 +01:00
css font: switch to hanken grotesk 2023-06-23 13:45:04 +01:00
docs use esbuild to compile and minify ts 2020-09-29 20:35:06 +01:00
html accounts: fix modify user card layout 2023-06-26 13:04:01 +01:00
images add discord link; new thumbnail variant 2021-12-21 13:43:37 +00:00
lang db: migrate user profiles 2023-06-24 21:29:54 +01:00
linecache Generate crash report txt and webpage 2021-06-11 21:56:53 +01:00
logger fix NewEmptyLogger 2021-10-03 15:59:58 +01:00
mail fix broken url in welcome email 2021-05-02 14:44:19 +01:00
ombi fix discord/telegram linking with ombi 2022-01-25 17:37:14 +00:00
scripts compile_mjml: use multiprocessing instead of thread 2023-06-24 11:36:15 +01:00
site readme/site: make project status message less pessimistic 2023-06-23 12:20:18 +01:00
static font: switch to hanken grotesk 2023-06-23 13:45:04 +01:00
ts admin: fix logout when url base is used 2023-06-26 20:28:20 +01:00
.drone.yml build: cleanup reprepro incoming after processing 2023-06-23 14:52:51 +01:00
.gitignore userpage: use form langfile, move login strings to common 2023-06-17 12:48:28 +01:00
.goreleaser.yml build: fix goreleaser, include optional builder name 2023-06-23 14:41:21 +01:00
api-invites.go db: remove remaining storage.loadX calls 2023-06-25 20:18:40 +01:00
api-messages.go db: deprecate customEmails/userPage 2023-06-25 19:40:54 +01:00
api-ombi.go db: migrate user profiles 2023-06-24 21:29:54 +01:00
api-profiles.go profiles: fix application 2023-06-26 13:01:17 +01:00
api-userpage.go db: remove remaining storage.loadX calls 2023-06-25 20:18:40 +01:00
api-users.go profiles: fix application 2023-06-26 13:01:17 +01:00
api.go pwr: ensure internal pwr pin is deleted after use 2023-06-22 17:35:34 +01:00
args.go args: fix help not usually showing 2023-06-11 15:48:27 +01:00
auth.go storage: user set/get methods for contact method access 2023-06-20 12:19:24 +01:00
autostart.go fix cross compilation in goreleaser/drone 2021-05-16 21:01:31 +01:00
config.go db: move legacy data loading out of main/config 2023-06-25 20:17:10 +01:00
CONTRIBUTING.md update contributing 2021-07-25 01:13:57 +01:00
daemon.go db: remove remaining storage.loadX calls 2023-06-25 20:18:40 +01:00
discord.go profiles: fix application 2023-06-26 13:01:17 +01:00
Dockerfile update node version in Dockerfile 2022-01-30 17:18:51 +00:00
email.go db: deprecate customEmails/userPage 2023-06-25 19:40:54 +01: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 profiles: fix application 2023-06-26 13:01:17 +01:00
go.sum profiles: fix application 2023-06-26 13:01:17 +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 userpage: show expiry 2023-06-18 12:27:18 +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 db: move legacy data loading out of main/config 2023-06-25 20:17:10 +01:00
Makefile Makefile: GOESBUIILD changes 2023-06-23 21:31:33 +01: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 profiles: fix application 2023-06-26 13:01:17 +01:00
notray.go tray: remove systray dep in non-tray builds 2021-08-18 17:25:16 +01:00
package-lock.json Makefile: GOESBUIILD changes 2023-06-23 21:31:33 +01:00
package.json Makefile: GOESBUIILD changes 2023-06-23 21:31:33 +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/site: make project status message less pessimistic 2023-06-23 12:20:18 +01: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 userpage: implement change password functionality 2023-06-22 20:54:52 +01:00
setup.go lang: add patchable notifications to common 2023-06-16 18:29:49 +01:00
static.go use embed.fs wrapper on data 2021-02-12 14:35:16 +00:00
storage.go profiles: fix application 2023-06-26 13:01:17 +01: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 build: fix goreleaser, include optional builder name 2023-06-23 14:41:21 +01:00
user-auth.go userpage: store refresh token separately 2023-06-18 12:30:23 +01:00
userdaemon.go db: migrate invites, user expiry 2023-06-24 19:13:05 +01:00
views.go db: deprecate customEmails/userPage 2023-06-25 19:40:54 +01:00

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.9, the latest version. 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 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.
    • CAPTCHAs 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.
  • 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 them via email/telegram.
  • Admin 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 the wiki page or 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: