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

Updated Setup (markdown)

Harvey Tindall 2020-04-19 22:49:59 +01:00
parent cb1d7ed62a
commit 577f7f6359
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Setup.md

@ -18,13 +18,10 @@ After that, open the config at the path specified and get to configuring.
* Enabling this will display a list of criteria when a user tries to create an account, and validate it against these when they try to submit. * Enabling this will display a list of criteria when a user tries to create an account, and validate it against these when they try to submit.
* The rest of the settings are self explanatory. * The rest of the settings are self explanatory.
* **email** * **email**
* Enabling this will store the emails that new users enter in the creation form and store them. When the user triggers a 'reset password' on the Jellyfin login page, the PIN required will be sent to the email address corresponding to the user. For pre-existing users, simply add them to the `emails.json` file. * You should set this up if you wish to use password resets and/or invite emails.
* `watch_directory` is the folder to watch for password reset files. To figure out where this should be, load up Jellyfin and press the 'Forgot password' button. Enter your username, and a popup will appear telling you the path of the created password reset file. Put that directory here.
* `use_24h` is pretty self-explanatory. It specifies whether to use '5:00 PM' or '17:00' in the emails sent out. * `use_24h` is pretty self-explanatory. It specifies whether to use '5:00 PM' or '17:00' in the emails sent out.
* `date_format` Allows you to choose how dates are displayed in emails. The default, for example, would print out the 1st of February 2020 as '01/02/20' To change this, make sure to use the `datetime.strftime` style. A cheatsheet for this can be found [here](https://strftime.org/). * `date_format` Allows you to choose how dates are displayed in emails. The default, for example, would print out the 1st of February 2020 as '01/02/20' To change this, make sure to use the `datetime.strftime` style. A cheatsheet for this can be found [here](https://strftime.org/).
* Unless you want to use a custom format for your emails, leave `email_template` and `email_plaintext` blank. If you want to customize them, look [here](https://github.com/hrfee/jellyfin-accounts#emailspassword-resets).
* `message` specifies a small message to show at the bottom of each email. * `message` specifies a small message to show at the bottom of each email.
* `subject` is the subject of the email.
* Currently, jellyfin-accounts support SMTP and mailgun for sending emails. The former will work with almost any email provider. Search up how to connect to your providers SMTP server if you don't know how to already. * Currently, jellyfin-accounts support SMTP and mailgun for sending emails. The former will work with almost any email provider. Search up how to connect to your providers SMTP server if you don't know how to already.
* `address` is the address emails will be sent from. If using SMTP, make sure this matches up with the password later on. * `address` is the address emails will be sent from. If using SMTP, make sure this matches up with the password later on.
* `from` is the name of who you want the email sent from. * `from` is the name of who you want the email sent from.
@ -36,5 +33,15 @@ After that, open the config at the path specified and get to configuring.
* **mailgun** * **mailgun**
* This section only needs to be modified if you've chosen it as the method up above. * This section only needs to be modified if you've chosen it as the method up above.
* It works with their REST API. Upon creating an account and setting up your domain, you should be displayed the API url and key. put these respectively as `api_url` and `api_key`. * It works with their REST API. Upon creating an account and setting up your domain, you should be displayed the API url and key. put these respectively as `api_url` and `api_key`.
* **password_resets**
* Enabling this will take the emails that new users enter in the creation form and store them. When the user triggers a 'reset password' on the Jellyfin login page, the PIN required will be sent to the email address corresponding to the user. For pre-existing users, simply add them to the `emails.json` file.
* `watch_directory` is the folder to watch for password reset files. To figure out where this should be, load up Jellyfin and press the 'Forgot password' button. Enter your username, and a popup will appear telling you the path of the created password reset file. Put that directory here.
* Unless you want to use a custom format for your emails, leave `email_html` and `email_text` blank. If you want to customize them, look [here](https://github.com/hrfee/jellyfin-accounts#emailspassword-resets).
* `subject` is the subject of the email.
* **invite_emails**
* Enabling this will allow you to optionally send an invite directly to the user's email.
* `email_html` and `email_text` work in the same way as above.
* `subject` again is the subject of the email.
* 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** * **files**
* These can be left blank, unless you want anything stored outside of `~/.jf-accounts/`. * These can be left blank, unless you want anything stored outside of `~/.jf-accounts/`.