hrfee/jellyfin-accounts
1
0
Fork 0
mirror of https://github.com/hrfee/jellyfin-accounts.git synced 2024-11-22 02:10:11 +00:00
Code Issues Projects Releases Wiki Activity

Added section on --get_defaults

Harvey Tindall 2020-06-07 15:13:57 +01:00
parent 53e43b48da
commit 27b0c6da7b
1 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Setup.md

@ -1,8 +1,28 @@
## First run
On your first run, accessing `<your ip>:8056` will bring you to the setup wizard.
Before you start configuring, you should make sure that timezones are correct everywhere. If you're running bare metal, this shouldn't be an issue, but docker containers are another story. For linuxserver.io Jellyfin containers, you should be able to use `-e TZ=Europe/London` but if not, `-v /etc/localtime:/etc/localtime:ro` works almost every where. Once you've added this run `docker exec -it <your container> bash` to enter its shell, then `date`. From there you can see if the time is correct.
Before you start configuring, you should make sure that timezones are correct everywhere. If you're running bare metal, this shouldn't be an issue, but docker containers are another story. For linuxserver.io Jellyfin containers, you should be able to use `-e TZ=Europe/London` but if not, `-v /etc/localtime:/etc/localtime:ro` usually works. Once you've added this run `docker exec -it <your container> bash` to enter its shell, then `date`. From there you can see if the time is correct.
If you want to manually configure, or change anything not included in the setup wizard, below are descriptions of each setting in `config.ini`.
## New account defaults
jf-accounts can store a users policy (library access, perms, etc.) and homescreen layout, and write them to all new users. Setting this up hasn't been implemented in the web UI setup yet, so you need to do this from the command line if you want it.
If you're running on bare metal, run
`root@lab ~# jf-accounts --get_defaults`
If you're using docker, make sure the container if already running and then run
```
root@lab ~# docker exec -it <your container name> bash
root@ed2244cc8ab4:/# jf-accounts -d /data --get_defaults
```
After that, follow through the prompts to store your defaults.
## Manual configuration
If you want to manually configure, or change anything after the first run, below are descriptions of each setting in `config.ini`.
* **jellyfin**
* Best practice is to create a separate admin account (I named mine 'accounts') without normal privileges (accessing media, etc.). Its credentials can then be entered.
@ -44,4 +64,4 @@ If you want to manually configure, or change anything not included in the setup
* Because one will most likely use jellyfin-accounts behind a reverse proxy, it has no way of knowing the URL it will be accessed from. The email sent out includes a link to the invite page, so `url_base` stores the location of the invite path, e.g `https://jellyf.in:8056/invite`.
* **files**
* `custom_css` allows you to specify the path to custom CSS for bootstrap. For more info, see [Appearance](https://github.com/hrfee/jellyfin-accounts/wiki/Appearance).
* The rest can be left blank, unless you want anything stored outside of `~/.jf-accounts/` (a.k.a `/config` on docker).
* The rest can be left blank, unless you want anything stored outside of the default directory (`~/.jf-accounts/` or `/config` on docker).