mirror of
https://github.com/hrfee/jfa-go.git
synced 2024-12-22 17:10:10 +00:00
107 lines
6.1 KiB
Markdown
107 lines
6.1 KiB
Markdown
|
|
[](https://drone.hrfee.dev/hrfee/jfa-go)
|
|
[](https://hub.docker.com/r/hrfee/jfa-go)
|
|
[](https://weblate.hrfee.pw/engage/jfa-go/)
|
|
|
|
##### Downloads:
|
|
##### [dockerhub](https://hub.docker.com/r/hrfee/jfa-go) | [stable](https://github.com/hrfee/jfa-go/releases) | [nightly](https://builds.hrfee.pw/view/hrfee/jfa-go) | [aur stable](https://aur.archlinux.org/packages/jfa-go) | [aur binary](https://aur.archlinux.org/packages/jfa-go-bin) | [aur nightly](https://aur.archlinux.org/packages/jfa-go-git)
|
|
---
|
|
jfa-go is a user management app for [Jellyfin](https://github.com/jellyfin/jellyfin) (and now [Emby](https://emby.media/)) 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.
|
|
* 📨 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.
|
|
* 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
|
|
* 🌓 Customizations
|
|
* Customize emails with variables and markdown
|
|
* Specify contact and help messages to appear in emails and pages
|
|
* Light and dark themes available
|
|
|
|
#### Interface
|
|
<p align="center">
|
|
<img src="images/demo.gif" width="100%"></img>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="images/invites.png" width="31%" style="margin-left: 1.5%;" alt="Invites tab"></img>
|
|
<img src="images/accounts.png" width="31%" style="margin-right: 1.5%;" alt="Accounts tab"></img>
|
|
<img src="images/create.png" width="31%" style="margin-right: 1.5%;" alt="Accounts creation"></img>
|
|
</p>
|
|
|
|
#### Install
|
|
|
|
The [Docker](https://hub.docker.com/r/hrfee/jfa-go) image is your best bet.
|
|
```sh
|
|
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](https://aur.archlinux.org/packages/jfa-go/), [jfa-go-bin](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 (or nightly builds [here](https://builds.hrfee.dev/view/hrfee/jfa-go)), 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](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.
|
|
|
|
```
|
|
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](https://github.com/hrfee/jfa-go/blob/main/CONTRIBUTING.md).
|
|
##### Translation
|
|
[](https://weblate.hrfee.pw/engage/jfa-go/)
|
|
|
|
For translations, use the weblate instance [here](https://weblate.hrfee.pw/engage/jfa-go/). You can login with github.
|