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 7a3e0d60f9
add expiry to welcome email, add dummy emailer for debugging
the "yourAccountWillExpire" has also been added to the editor for #81.
To use the dummy emailer, set [email]/method to "dummy".
2021-04-08 14:20:13 +01:00
.github add other funding method 2021-03-09 18:45:28 +00:00
common remove dependency on common from mediabrowser 2021-03-29 20:57:13 +01:00
config add password reset link option 2021-03-30 22:41:28 +01:00
css add password reset link option 2021-03-30 22:41:28 +01:00
docs use esbuild to compile and minify ts 2020-09-29 20:35:06 +01:00
html use proper date formatting on form for expiry 2021-04-07 15:17:15 +01:00
images update images and readme 2021-03-20 19:04:26 +00:00
lang add expiry to welcome email, add dummy emailer for debugging 2021-04-08 14:20:13 +01:00
mail add expiry to welcome email, add dummy emailer for debugging 2021-04-08 14:20:13 +01:00
ombi refactor; separate jfapi and ombi into modules 2020-11-02 00:53:08 +00:00
scripts use build constraints for embed, clean up makefile 2021-04-01 14:22:11 +01:00
static Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
ts use proper date formatting on form for expiry 2021-04-07 15:17:15 +01:00
.drone.yml use apt-get in drone.yml 2021-04-03 21:38:26 +01:00
.gitignore remove cl.md 2021-04-07 17:45:31 +01:00
.goreleaser.yml use build constraints for embed, clean up makefile 2021-04-01 14:22:11 +01:00
api.go add expiry to welcome email, add dummy emailer for debugging 2021-04-08 14:20:13 +01:00
auth.go use different color library, wrap logger functions with it 2021-02-19 16:12:14 +00:00
config.go add password reset link option 2021-03-30 22:41:28 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md, mb 0.3.3 2021-04-05 16:34:47 +01:00
daemon.go implement user expiry functionality 2021-02-28 15:41:06 +00:00
Dockerfile use build constraints for embed, clean up makefile 2021-04-01 14:22:11 +01:00
email.go add expiry to welcome email, add dummy emailer for debugging 2021-04-08 14:20:13 +01:00
external.go use build constraints for embed, clean up makefile 2021-04-01 14:22:11 +01:00
go.mod use unix timestamp for inv created & usedBy 2021-04-06 21:25:44 +01:00
go.sum use unix timestamp for inv created & usedBy 2021-04-06 21:25:44 +01:00
internal.go use build constraints for embed, clean up makefile 2021-04-01 14:22:11 +01:00
jfa-go.service fix dropdown colors in dark mode on chrome 2021-03-09 18:15:14 +00:00
lang.go add password reset link option 2021-03-30 22:41:28 +01:00
LICENSE update license date 2021-01-29 01:20:05 +00:00
logger.go rewrite lang.go format and templateString 2021-03-27 16:07:22 +00:00
main.go shutdown your background workers! 2021-04-06 18:12:06 +01:00
Makefile remove ts-debug 2021-04-01 14:33:57 +01:00
models.go use unix timestamp for inv created & usedBy 2021-04-06 21:25:44 +01:00
package-lock.json respect browser/os dark mode preference 2021-03-10 19:42:40 +00:00
package.json respect browser/os dark mode preference 2021-03-10 19:42:40 +00:00
pwreset.go Implement email template generation 2021-02-19 21:38:20 +00:00
pwval.go live validation on form, change special character definition 2021-01-09 01:00:27 +00:00
README.md Fix docker link in README.md 2021-04-04 08:32:38 +12:00
router.go add password reset link option 2021-03-30 22:41:28 +01:00
setup.go move mediabrowser to separate repo 2021-03-29 21:49:46 +01:00
static.go use embed.fs wrapper on data 2021-02-12 14:35:16 +00:00
storage.go fix incomplete lang patching, add en-gb stub 2021-04-07 17:42:15 +01:00
stripmd.go rewrite stripmd, fix some typos 2021-03-26 23:13:19 +00:00
updater.go updater: immediately store executable 2021-04-07 18:17:18 +01:00
userdaemon.go clear user cache when user expires 2021-04-06 18:39:12 +01:00
views.go use proper date formatting on form for expiry 2021-04-07 15:17:15 +01:00

jfa-go Build Status Docker Hub Translation status

Downloads:
dockerhub | stable | nightly | aur stable | aur binary | aur nightly

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.

I chose to rewrite the python jellyfin-accounts in Go mainly as a learning experience, but also to slightly improve speeds and efficiency.

Features

  • 🧑 Invite based account creation: Sends 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.
  • 📨 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.
  • Notifications: Get notified when someone creates an account, or an invite expires.
  • 📣 Announcements: Bulk email 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
  • 🌓 Customizable look
    • Edit 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

The Docker image is your best bet.

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

Available on the AUR as jfa-go, jfa-go-bin or jfa-go-git.

For other platforms, grab an archive from the release section for your platform (or nightly builds here), and extract the jfa-go 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.

Note: jfa-go does not run as a daemon by default. You'll need to figure this out yourself.

Usage of ./jfa-go:
  -config string
    	alternate path to config file. (default "~/.config/jfa-go/config.ini")
  -data string
    	alternate path to data directory. (default "~/.config/jfa-go")
  -debug
    	Enables debug logging and exposes pprof.
  -host string
    	alternate address to host web ui on.
  -port int
    	alternate port to host web ui on.
  -swagger
    	Enable swagger at /swagger/index.html

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.