1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-12-22 09:00:10 +00:00
jfa-go/README.md

90 lines
4.7 KiB
Markdown
Raw Normal View History

2020-08-31 14:30:48 +00:00
# ![jfa-go](data/static/banner.svg)
2020-07-29 21:11:28 +00:00
2020-08-18 14:47:03 +00:00
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 profiles: Assign settings profiles to invites so new users have your predefined permissions, homescreen layout, etc. applied to their account on creation.
2020-08-18 14:47:03 +00:00
* Password validation: Ensure users choose a strong password.
2020-09-05 16:59:20 +00:00
* 🔗 Ombi Integration: Automatically creates Ombi accounts for new users using their email address and login details, and your own defined set of permissions.
2020-09-19 15:38:53 +00:00
* 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.
2020-08-18 14:47:03 +00:00
* 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
<p align="center">
2020-09-19 15:40:33 +00:00
<img src="https://github.com/hrfee/jfa-go/blob/main/images/demo.gif" width="100%"></img>
2020-08-18 14:47:03 +00:00
</p>
<p align="center">
2020-09-19 15:40:33 +00:00
<img src="https://github.com/hrfee/jfa-go/blob/main/images/invites.png" width="48%" style="margin-left: 1.5%;" alt="Invites tab"></img>
<img src="https://github.com/hrfee/jfa-go/blob/main/images/accounts.png" width="48%" style="margin-right: 1.5%;" alt="Accounts tab"></img>
2020-08-18 14:47:03 +00:00
</p>
2020-08-02 01:11:50 +00:00
2020-08-03 19:10:45 +00:00
#### Install
2020-08-19 11:31:16 +00:00
2020-09-03 21:12:55 +00:00
Available on the AUR as [jfa-go](https://aur.archlinux.org/packages/jfa-go/) or [jfa-go-git](https://aur.archlinux.org/packages/jfa-go-git/).
For other platforms, grab an archive from the release section for your platform, and extract `jfa-go` and `data` to the same directory.
* For linux users, you can place them inside `/opt/jfa-go` and then run
2020-08-19 11:31:16 +00:00
`sudo ln -s /opt/jfa-go/jfa-go /usr/bin/jfa-go` to place it in your PATH.
2020-08-02 01:11:50 +00:00
Run the executable to start.
2020-08-03 19:10:45 +00:00
For [docker](https://hub.docker.com/repository/docker/hrfee/jfa-go), run:
```
docker create \
--name "jfa-go" \ # Whatever you want to name it
-p 8056:8056 \
-v /path/to/.config/jfa-go:/data \ # Path to wherever you want to store the config file and other data
2020-08-03 19:10:45 +00:00
-v /path/to/jellyfin:/jf \ # Path to jellyfin config directory
-v /etc/localtime:/etc/localtime:ro \ # Makes sure time is correct
2020-09-15 11:23:43 +00:00
hrfee/jfa-go # hrfee/jfa-go:unstable for latest build from git
2020-08-03 19:10:45 +00:00
```
2020-08-18 14:47:03 +00:00
#### 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).
2020-08-03 19:10:45 +00:00
#### Usage
2020-08-18 14:47:03 +00:00
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.
2020-08-02 01:11:50 +00:00
```
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")
2020-09-19 15:38:53 +00:00
-debug
Enables debug logging and exposes pprof.
2020-08-02 01:11:50 +00:00
-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
2020-08-02 01:11:50 +00:00
```
2020-08-18 14:47:03 +00:00
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.*)