From af47cd9f0b6f03e90bc09490473235eb7c41c34c Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 18 Aug 2020 15:47:03 +0100 Subject: [PATCH] Improve README --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 41 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6ebd517..08e5f8c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,35 @@ # ![jfa-go](images/jfa-go-banner-wide.svg) -A rewrite of [jellyfin-accounts](https://github.com/hrfee/jellyfin-accounts) in Go. It has feature parity with the Python version, but should be faster. +jfa-go is a user management app for [Jellyfin](https://github.com/jellyfin/jellyfin) 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](https://github.com/hrfee/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 defaults: Configure an example account to your liking, and its permissions, access rights and homescreen layout can be applied to all new users. + * Password validation: Ensure users choose a strong password. +* 📨 Email storage: Add your existing user's 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 + * Optionally provide custom CSS + +## Interface +

+ +

+ +

+ Admin page + Account creation page +

#### Install Grab an archive from the release section for your platform, and extract `jfa-go` and `data` to the same directory. @@ -16,7 +45,17 @@ docker create \ -v /etc/localtime:/etc/localtime:ro \ # Makes sure time is correct hrfee/jfa-go ``` + +#### Build from source +A Dockerfile is provided that creates an image built from source, but it's only suitable for those who will run jfa-go in docker. + +Full build instructions can be found [here](https://github.com/hrfee/jfa-go/wiki/Build). + #### 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 @@ -29,12 +68,10 @@ Usage of ./jfa-go: alternate port to host web ui on. ``` -To switch from jf-accounts, copy your existing `~/.jf-accounts` to: +If you're switching from jellyfin-accounts, copy your existing `~/.jf-accounts` to: * `XDG_CONFIG_DIR/jfa-go` (usually ~/.config) on \*nix systems, * `%AppData%/jfa-go` on Windows, * `~/Library/Application Support/jfa-go` on macOS. (*or specify config/data path with `-config/-data` respectively.*) - -This is the first time i've even touched Go, and the code is a mess, so help is very welcome.