1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-12-22 17:10:10 +00:00
a better way to manage your Jellyfin users, now in go.
Go to file
Harvey Tindall e931c09a34
add message when web ui is loaded
a lack of output after "Loading routes" was a little confusing.
2021-05-21 21:39:32 +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 mention wiki in telegram settings description 2021-05-07 23:36:46 +01:00
css Telegram: Change user's contact method in accounts 2021-05-08 15:53:42 +01:00
docs use esbuild to compile and minify ts 2020-09-29 20:35:06 +01:00
html Split some settings into new "messages" section 2021-05-07 21:53:29 +01:00
images add example bot settings for wiki 2021-05-08 16:37:40 +01:00
lang Translated using Weblate (Portuguese (Brazil)) 2021-05-09 20:59:31 +02:00
logger refactor; move logger to module 2021-05-01 00:13:57 +01:00
mail fix broken url in welcome email 2021-05-02 14:44:19 +01:00
ombi ombi: reset password when using pwr links 2021-05-02 13:23:59 +01:00
scripts fix generate_ini for multiline descriptions 2021-05-16 23:00:37 +01:00
static Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
ts Merge branch 'main' into telegram 2021-05-08 16:08:20 +01:00
.drone.yml change notray/tray naming, add deb/rpm/apk 2021-05-16 22:44:04 +01:00
.gitignore Telegram: add language files 2021-05-07 23:45:53 +01:00
.goreleaser.yml consistent naming for tray builds 2021-05-16 23:02:09 +01:00
api.go hide/ignore ssl_cert when on windows 2021-05-17 01:16:59 +01:00
args.go refactor; move logger to module 2021-05-01 00:13:57 +01:00
auth.go use different color library, wrap logger functions with it 2021-02-19 16:12:14 +00:00
autostart.go fix cross compilation in goreleaser/drone 2021-05-16 21:01:31 +01:00
config.go Split some settings into new "messages" section 2021-05-07 21:53:29 +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 remove debug println 2021-05-17 01:32:22 +01:00
external.go use build constraints for embed, clean up makefile 2021-04-01 14:22:11 +01:00
go.mod fix cross compilation in goreleaser/drone 2021-05-16 21:01:31 +01:00
go.sum fix cross compilation in goreleaser/drone 2021-05-16 21:01:31 +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 almost complete telegram user verification 2021-05-07 01:08:12 +01:00
LICENSE update license date 2021-01-29 01:20:05 +00:00
main.go add message when web ui is loaded 2021-05-21 21:39:32 +01:00
Makefile add basic tray functionality 2021-05-16 16:23:28 +01:00
models.go Telegram: Change user's contact method in accounts 2021-05-08 15:53:42 +01:00
notray.go add basic tray functionality 2021-05-16 16:23:28 +01:00
package-lock.json cleanup; fix stripping with DEBUG=on 2021-05-16 15:00:13 +01:00
package.json Bump lodash from 4.17.20 to 4.17.21 2021-05-11 21:24:34 +00:00
pwreset.go Telegram: Send messages via telegram 2021-05-07 16:06:47 +01:00
pwval.go live validation on form, change special character definition 2021-01-09 01:00:27 +00:00
README.md Mention telegram in readme 2021-05-07 23:18:44 +01: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 Telegram: Change user's contact method in accounts 2021-05-08 15:53:42 +01:00
setup.go Split some settings into new "messages" section 2021-05-07 21:53:29 +01:00
static.go use embed.fs wrapper on data 2021-02-12 14:35:16 +00:00
storage.go telegram: Fix UI and store useful Telegram info 2021-05-07 14:32:51 +01:00
stripmd.go rewrite stripmd, fix some typos 2021-03-26 23:13:19 +00:00
telegram.go cleanup; fix stripping with DEBUG=on 2021-05-16 15:00:13 +01:00
template.go Fix email editor for other email types 2021-04-22 19:16:41 +01:00
tray.go fix cross compilation in goreleaser/drone 2021-05-16 21:01:31 +01:00
updater.go add hard restart for updates on *nix 2021-05-03 20:08:23 +01:00
userdaemon.go Split some settings into new "messages" section 2021-05-07 21:53:29 +01:00
views.go Split some settings into new "messages" section 2021-05-07 21:53:29 +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.

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.
  • Telegram Integration: Verify users via telegram, 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

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.

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

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.