1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-11-14 22:30:10 +00:00
a better way to manage your Jellyfin users, now in go.
Go to file
2021-12-31 01:51:42 +00:00
.github fix FAQ link in bug report template 2021-12-20 18:52:06 +00:00
common Show log on log.Fatal calls, provide "sanitized" version, fix goreleaser 2021-06-11 23:28:21 +01:00
config form: add setting for changing redirect url 2021-12-20 20:44:08 +00:00
css fix more oddities 2021-12-31 01:51:42 +00:00
docs use esbuild to compile and minify ts 2020-09-29 20:35:06 +01:00
html fix more oddities 2021-12-31 01:51:42 +00:00
images add discord link; new thumbnail variant 2021-12-21 13:43:37 +00:00
lang Translated using Weblate (Spanish) 2021-12-28 00:56:15 +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 Ombi: Integrate with profiles, Retire user defaults 2021-11-13 18:53:53 +00:00
scripts fix more oddities 2021-12-31 01:51:42 +00:00
site tailwind: upgrade a17t, somewhat functional dark mode 2021-12-30 00:49:43 +00:00
static Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
ts fix more oddities 2021-12-31 01:51:42 +00:00
.drone.yml apidocs: re-version, set up for hosted ui 2021-11-15 00:19:52 +00:00
.gitignore add dark variants to ts 2021-12-30 02:45:29 +00:00
.goreleaser.yml merge translation 2021-11-14 14:58:28 +00:00
api.go email: Add option to require on sign-up 2021-12-20 18:50:48 +00:00
args.go refactor; move logger to module 2021-05-01 00:13:57 +01:00
auth.go apidocs: re-version, set up for hosted ui 2021-11-15 00:19:52 +00:00
autostart.go fix cross compilation in goreleaser/drone 2021-05-16 21:01:31 +01:00
config.go form: add setting for changing redirect url 2021-12-20 20:44:08 +00:00
CONTRIBUTING.md update contributing 2021-07-25 01:13:57 +01:00
discord.go Discord: Try to avoid more race conditions 2021-05-23 22:26:56 +01:00
Dockerfile add inline to Dockerfile 2021-06-20 20:01:04 +01:00
email.go SMTP: Always use plaintext as main body 2021-11-10 20:12:31 +00:00
exit.go print error and include in txt log on crash; fix email migration 2021-08-25 18:10:06 +01:00
external.go fix external fs 2021-07-16 15:39:22 +01:00
go.mod accounts: hide "Send PWR" when link resets disabled 2021-12-24 19:05:48 +00:00
go.sum accounts: hide "Send PWR" when link resets disabled 2021-12-24 19:05:48 +00:00
internal.go almost complete telegram user verification 2021-05-07 01:08:12 +01:00
invdaemon.go Move all migrations to separate file 2021-06-01 14:18:49 +01:00
jfa-go.service fix dropdown colors in dark mode on chrome 2021-03-09 18:15:14 +00:00
lang.go Setup: add messages, set password via link 2021-06-23 15:44:48 +01:00
LICENSE matrix: end-to-end encryption by default 2021-07-13 19:02:16 +01:00
log.go print error if logging fails 2021-12-20 19:05:18 +00:00
main.go print error if logging fails 2021-12-20 19:05:18 +00:00
Makefile switch to DOM based variant adding 2021-12-30 23:52:53 +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 matrix: fix instant crash with e2ee 2021-07-20 15:34:39 +01:00
migrations.go invites: allow notification by discord/telegram/matrix 2021-11-17 16:20:57 +00:00
models.go Ombi: Integrate with profiles, Retire user defaults 2021-11-13 18:53:53 +00:00
notray.go tray: remove systray dep in non-tray builds 2021-08-18 17:25:16 +01:00
package-lock.json switch to DOM based variant adding 2021-12-30 23:52:53 +00:00
package.json switch to DOM based variant adding 2021-12-30 23:52:53 +00:00
pwreset.go admin: add manual "Send Password reset" to accounts tab 2021-10-13 15:04:22 +01:00
pwval.go live validation on form, change special character definition 2021-01-09 01:00:27 +00:00
README.md add discord link; new thumbnail variant 2021-12-21 13:43:37 +00:00
restart_windows.go add hard restart for updates on *nix 2021-05-03 20:08:23 +01:00
restart.go add hard restart for updates on *nix 2021-05-03 20:08:23 +01:00
router.go Ombi: Integrate with profiles, Retire user defaults 2021-11-13 18:53:53 +00:00
setup.go setup: add descriptive "test connection" messages; disable next button 2021-07-24 14:15:10 +01:00
static.go use embed.fs wrapper on data 2021-02-12 14:35:16 +00:00
storage.go Ombi: Integrate with profiles, Retire user defaults 2021-11-13 18:53:53 +00:00
stripmd.go Discord: Remove extra newlines around links 2021-05-23 01:05:53 +01:00
tailwind.config.js remove predefined m- and p- spacing 2021-12-30 23:58:20 +00:00
telegram.go Matrix: Setup bot, add PIN verification 2021-05-29 17:43:11 +01:00
template.go Fix email editor for other email types 2021-04-22 19:16:41 +01:00
tray.go tray: remove systray dep in non-tray builds 2021-08-18 17:25:16 +01:00
updater.go expand CONTRIBUTING, print if tray enabled on startup 2021-05-24 15:58:43 +01:00
userdaemon.go Split some settings into new "messages" section 2021-05-07 21:53:29 +01:00
views.go form: add setting for changing redirect url 2021-12-20 20:44:08 +00:00

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: