jfa-go/README.md

41 lines
1.5 KiB
Markdown
Raw Normal View History

2020-08-02 03:11:50 +02:00
# ![jfa-go](images/jfa-go-banner-wide.svg)
2020-07-29 23:11:28 +02:00
2020-08-02 18:25:33 +02:00
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.
2020-08-02 03:11:50 +02:00
2020-08-03 21:10:45 +02:00
#### Install
2020-08-02 03:11:50 +02:00
Grab an archive from the release section for your platform, and extract `jfa-go` and `data` to the same directory.
Run the executable to start.
2020-08-03 21:10:45 +02: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 \ # Equivalent of ~/.jf-accounts
-v /path/to/jellyfin:/jf \ # Path to jellyfin config directory
-v /etc/localtime:/etc/localtime:ro \ # Makes sure time is correct
hrfee/jfa-go
```
#### Usage
2020-08-02 03:11:50 +02: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")
-host string
alternate address to host web ui on.
-port int
alternate port to host web ui on.
```
To switch from jf-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.*)
2020-07-29 23:11:28 +02:00
2020-08-02 03:11:50 +02:00
This is the first time i've even touched Go, and the code is a mess, so help is very welcome.