1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-06-25 19:07:47 +02:00
a better way to manage your Jellyfin users, now in go.
Go to file
Harvey Tindall 92332206f0
add basic update functionality
If enabled, jfa-go pings buildrone (hosted at builds.hrfee.pw) every 30
min for new updates. If there is one, it gets information (and if
applicable, a binary) from the appropriate source (buildrone, github, or
dockerhub) and displays it on the admin page. You can switch update
channels between stable and unstable. For binary releases, updates are
downloaded automatically and installed when the user presses update.

Since this obviously introduces some "phone-home" functionality into
jfa-go, I just want to say IPs are not and will not be logged by
buildrone, although I may later introduce functionality to give a rough
idea of the number of users (again, no IPs stored). The whole thing can
also be turned off in settings.
2021-03-07 15:23:44 +00:00
.github lowercase lang, go mod tidy 2021-02-16 14:31:31 +00:00
common add rough error logging for read/write errors 2020-11-02 23:20:06 +00:00
config add basic update functionality 2021-03-07 15:23:44 +00:00
css add basic update functionality 2021-03-07 15:23:44 +00:00
docs use esbuild to compile and minify ts 2020-09-29 20:35:06 +01:00
embed add basic update functionality 2021-03-07 15:23:44 +00:00
html add basic update functionality 2021-03-07 15:23:44 +00:00
images Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
lang add basic update functionality 2021-03-07 15:23:44 +00:00
mail implement user expiry functionality 2021-02-28 15:41:06 +00:00
mediabrowser cleanup logs and use structs in jf/emby api 2021-02-19 00:47:01 +00:00
ombi refactor; separate jfapi and ombi into modules 2020-11-02 00:53:08 +00:00
scripts add basic update functionality 2021-03-07 15:23:44 +00:00
static Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
ts add basic update functionality 2021-03-07 15:23:44 +00:00
.drone.yml add basic update functionality 2021-03-07 15:23:44 +00:00
.gitignore add external/internal data options 2021-02-12 14:32:48 +00:00
.goreleaser.yml add basic update functionality 2021-03-07 15:23:44 +00:00
api.go add basic update functionality 2021-03-07 15:23:44 +00:00
auth.go use different color library, wrap logger functions with it 2021-02-19 16:12:14 +00:00
config.go add basic update functionality 2021-03-07 15:23:44 +00:00
CONTRIBUTING.md mention new weblate instance 2021-01-17 20:02:02 +00:00
daemon.go implement user expiry functionality 2021-02-28 15:41:06 +00:00
Dockerfile add basic update functionality 2021-03-07 15:23:44 +00:00
email.go implement user expiry functionality 2021-02-28 15:41:06 +00:00
go.mod add basic update functionality 2021-03-07 15:23:44 +00:00
go.sum add basic update functionality 2021-03-07 15:23:44 +00:00
lang.go implement user expiry functionality 2021-02-28 15:41:06 +00:00
LICENSE update license date 2021-01-29 01:20:05 +00:00
logger.go use different color library, wrap logger functions with it 2021-02-19 16:12:14 +00:00
main.go add basic update functionality 2021-03-07 15:23:44 +00:00
Makefile add basic update functionality 2021-03-07 15:23:44 +00:00
models.go add basic update functionality 2021-03-07 15:23:44 +00:00
package-lock.json add basic update functionality 2021-03-07 15:23:44 +00:00
package.json add basic update functionality 2021-03-07 15:23:44 +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 add download links at top, mention jfa-go-bin 2021-03-02 01:30:08 +00:00
router.go add basic update functionality 2021-03-07 15:23:44 +00:00
setup.go use filepath.Join wrapper for different embed and os path styles 2021-02-12 14:59:35 +00:00
static.go use embed.fs wrapper on data 2021-02-12 14:35:16 +00:00
storage.go implement user expiry functionality 2021-02-28 15:41:06 +00:00
stripmd.go implement email editor w/ live(?) preview 2021-02-20 22:49:59 +00:00
updater.go add basic update functionality 2021-03-07 15:23:44 +00:00
userdaemon.go implement user expiry functionality 2021-02-28 15:41:06 +00:00
views.go include LICENSE in build, display in about tab 2021-03-01 00:32:09 +00: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.
  • 🔗 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 user's 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
    • Specify contact and help messages to appear in emails and pages
    • Light and dark themes available

Interface

Invites tab Accounts tab

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
             -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.