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 8c871bc5fa
Add ts to link setting dependance
Also make store each setting as classes in a settings object, to make it
easier to serialize on submitting. Also, added
"substitute_jellyfin_strings", "no_username" and welcome_email.
2021-01-26 22:57:29 +00:00
.github/ISSUE_TEMPLATE add issue template 2020-09-15 12:00:20 +01:00
common add rough error logging for read/write errors 2020-11-02 23:20:06 +00:00
config split some strings into common file; use lang file to setup page 2021-01-25 21:26:54 +00:00
css Initial setup page content 2021-01-24 23:05:04 +00:00
docs use esbuild to compile and minify ts 2020-09-29 20:35:06 +01:00
html Add ts to link setting dependance 2021-01-26 22:57:29 +00:00
images Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
lang Add ts to link setting dependance 2021-01-26 22:57:29 +00:00
mail add optional welcome email for new users 2021-01-24 15:19:58 +00:00
mediabrowser compiles, basic issues fixed 2021-01-10 16:10:03 +00:00
ombi refactor; separate jfapi and ombi into modules 2020-11-02 00:53:08 +00:00
static Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
ts Add ts to link setting dependance 2021-01-26 22:57:29 +00:00
.drone.yml dont attempt to release PRs on buildrone 2021-01-08 23:52:36 +00:00
.gitignore add optional tls/http2 support 2021-01-15 14:43:32 +00:00
.goreleaser.yml bundle typescript 2021-01-23 19:08:27 +00:00
api.go Add ts to link setting dependance 2021-01-26 22:57:29 +00:00
auth.go dont re-b64 the jwt 2020-11-12 21:25:52 +00:00
config.go add optional welcome email for new users 2021-01-24 15:19:58 +00:00
CONTRIBUTING.md mention new weblate instance 2021-01-17 20:02:02 +00:00
daemon.go add URL base option for subfolder proxies 2020-11-22 16:36:43 +00:00
Dockerfile Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
email.go add optional welcome email for new users 2021-01-24 15:19:58 +00:00
go.mod bundle typescript 2021-01-23 19:08:27 +00:00
go.sum bundle typescript 2021-01-23 19:08:27 +00:00
lang.go Add ts to link setting dependance 2021-01-26 22:57:29 +00:00
LICENSE Added install step to makefile; start PKGBUILD 2020-08-19 12:10:34 +01:00
main.go Add ts to link setting dependance 2021-01-26 22:57:29 +00:00
Makefile Add ts to link setting dependance 2021-01-26 22:57:29 +00:00
models.go Add optional label for invites 2021-01-24 15:55:45 +00:00
package-lock.json Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
package.json Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
pwreset.go add URL base option for subfolder proxies 2020-11-22 16:36:43 +00:00
pwval.go live validation on form, change special character definition 2021-01-09 01:00:27 +00:00
README.md mention new weblate instance 2021-01-17 20:02:02 +00:00
README.md.old Merge a17t-redesign, kinda ts-ify setup.js 2021-01-05 18:16:23 +00:00
setup.go Add ts to link setting dependance 2021-01-26 22:57:29 +00:00
storage.go split some strings into common file; use lang file to setup page 2021-01-25 21:26:54 +00:00
test.css bundle css with esbuild 2021-01-23 18:53:14 +00:00
version.py version based on current tag for makefile 2020-09-15 12:12:51 +01:00
views.go bundle css with esbuild 2021-01-23 18:53:14 +00:00

jfa-go Build Status Docker Hub Translation status

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

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

For other platforms, grab an archive from the release section for your platform (or nightly builds here), and extract jfa-go and data to the same directory.

  • For linux users, you can place them inside /opt/jfa-go and then run sudo ln -s /opt/jfa-go/jfa-go /usr/bin/jfa-go to place it in your PATH.

Run the executable to start.

For docker, run:

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

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.