hrfee/jfa-go
1
0
Fork 0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-12-23 01:20:11 +00:00
Code Issues Projects Releases Wiki Activity
ade032241a
jfa-go/config/config-base.json

1979 lines
83 KiB
JSON
Raw Normal View History

Display settings with hacky solution to retain order Python utility included to convert config-base.json into a new version which includes lists that define the order settings should be displayed. admin.js edited to recognize this.
2020-07-31 15:09:30 +00:00
{
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"order": [],
"sections": {
add basic update functionality If enabled, jfa-go pings buildrone (hosted at builds.hrfee.pw) every 30 min for new updates. If there is one, it gets information (and if applicable, a binary) from the appropriate source (buildrone, github, or dockerhub) and displays it on the admin page. You can switch update channels between stable and unstable. For binary releases, updates are downloaded automatically and installed when the user presses update. Since this obviously introduces some "phone-home" functionality into jfa-go, I just want to say IPs are not and will not be logged by buildrone, although I may later introduce functionality to give a rough idea of the number of users (again, no IPs stored). The whole thing can also be turned off in settings.
2021-03-07 15:23:44 +00:00
"updates": {
"order": [],
"meta": {
"name": "Updates",
"description": "Settings for update notifications and release channel."
},
"settings": {
"enabled": {
"name": "Enabled",
"required": true,
"requires_restart": true,
"type": "bool",
"value": true,
"description": "Enable/disable updating notifications and downloading/applying updates."
},
"channel": {
"name": "Release Channel",
"required": true,
"requires_restart": false,
"type": "select",
"options": [
["stable", "Stable"],
["unstable", "Unstable"]
],
"value": "",
"description": "Release channel for updates."
}
}
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"jellyfin": {
"order": [],
"meta": {
"name": "Jellyfin",
"description": "Settings for connecting to Jellyfin"
},
"settings": {
"username": {
"name": "Jellyfin Username",
"required": true,
"requires_restart": true,
"type": "text",
"value": "username",
"description": "It is recommended to create a limited admin account for this program."
},
"password": {
"name": "Jellyfin Password",
"required": true,
"requires_restart": true,
"type": "password",
"value": "password"
},
"server": {
"name": "Server address",
"required": true,
"requires_restart": true,
"type": "text",
"value": "http://jellyfin.local:8096",
"description": "Jellyfin server address. Can be public, or local for security purposes."
},
"public_server": {
"name": "Public address",
"required": false,
"requires_restart": false,
"type": "text",
"value": "https://jellyf.in:443",
"description": "Publicly accessible Jellyfin address for invite form. Leave blank to reuse the above address."
},
"client": {
"name": "Client Name",
"required": true,
"requires_restart": true,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"type": "text",
"value": "jfa-go",
"description": "The name of the client that will show up in the Jellyfin dashboard."
},
"cache_timeout": {
"name": "User cache timeout (minutes)",
"required": false,
"requires_restart": true,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"type": "number",
"value": 30,
"description": "Timeout of user cache in minutes. Set to 0 to disable."
compiles, basic issues fixed Server type is found under the Jellyfin settings tab, where you can change it to emby. Currently: * logs in * creates users * parses accounts
2021-01-09 20:38:13 +00:00
},
"type": {
"name": "Server type",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
["jellyfin", "Jellyfin"],
["emby", "Emby"]
compiles, basic issues fixed Server type is found under the Jellyfin settings tab, where you can change it to emby. Currently: * logs in * creates users * parses accounts
2021-01-09 20:38:13 +00:00
],
"value": "jellyfin",
rebase 12/02, use go1.16rc1 in make, remove ioutil, start switching to io/fs for file i/o ioutil's contents are now in io and os. Eventually jfa-go's files will be embedded in the binary with go1.16's new embed feature. Using io/fs will provide abstraction for accessing these files, and allow for both embedded and non-embedded versions. Also, internal paths to things like email templates, etc. will be prefixed with "jfa-go:" to indicate to use the app's own Filesystem instead of reading the file normally. This also allows for custom files to continue to be used as they are currently.
2021-01-31 23:12:50 +00:00
"description": "Note: Emby integration works but is missing some features, such as Password Resets."
option to substitute "Jellyfin" in form.html setting is jellyfin/substitute_jellyfin_strings.
2021-01-10 15:51:04 +00:00
},
"substitute_jellyfin_strings": {
"name": "Substitute occurrences of \"Jellyfin\"",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
add plaintext email option, use text/template text/template is used on plaintext emails to avoid escaping of certain characters.
2021-02-18 18:26:23 +00:00
"description": "Optionally substitute occurrences of \"Jellyfin\" in the account creation form and emails with this. May result in bad grammar."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
}
}
},
"ui": {
"order": [],
"meta": {
"name": "General",
"description": "Settings related to the UI and program functionality."
},
"settings": {
separate options for form and admin language
2021-01-12 23:37:22 +00:00
"language-form": {
add language selector to form
2021-01-11 19:17:43 +00:00
"name": "Default Form Language",
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"required": false,
"requires_restart": true,
"type": "select",
"options": [
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
["en-us", "English (US)"]
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
],
Fix initial language setting value For some reason it was set as en-US, not en-us.
2021-01-18 00:14:12 +00:00
"value": "en-us",
update weblate link
2021-06-30 17:06:31 +00:00
"description": "Default Account Form Language. Visit weblate.jfa-go.com if you'd like to translate."
separate options for form and admin language
2021-01-12 23:37:22 +00:00
},
"language-admin": {
"name": "Default Admin Language",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
["en-us", "English (US)"]
separate options for form and admin language
2021-01-12 23:37:22 +00:00
],
Fix initial language setting value For some reason it was set as en-US, not en-us.
2021-01-18 00:14:12 +00:00
"value": "en-us",
update weblate link
2021-06-30 17:06:31 +00:00
"description": "Default Admin page Language. Settings has not been translated. Visit weblate.jfa-go.com if you'd like to translate."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"theme": {
"name": "Default Look",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
["Jellyfin (Dark)", "Jellyfin (Dark)"],
["Default (Light)", "Default (Light)"]
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
],
"value": "Jellyfin (Dark)",
"description": "Default appearance for all users."
},
"host": {
"name": "Address",
"required": true,
"requires_restart": true,
"type": "text",
"value": "0.0.0.0",
"description": "Set 0.0.0.0 to run on localhost"
},
"port": {
"name": "Port",
"required": true,
"requires_restart": true,
"type": "number",
"value": 8056
},
"jellyfin_login": {
"name": "Use Jellyfin for authentication",
"required": false,
"requires_restart": true,
"type": "bool",
"value": true,
"description": "Enable this to use Jellyfin users instead of the below username and pw."
},
"admin_only": {
"name": "Allow admin users only",
"required": false,
"requires_restart": true,
"depends_true": "jellyfin_login",
"type": "bool",
"value": true,
"description": "Allows only admin users on Jellyfin to access the admin page."
},
accounts: allow giving individual users jfa-go access New "Access jfa-go" column allows you to select users for jfa-go access. New "Allow All" setting allows all Jellyfin users access, as disabling "Admin Only" no longer does this.
2022-01-09 19:29:17 +00:00
"allow_all": {
"name": "Allow all users to login",
"required": false,
"requires_restart": true,
"depends_true": "jellyfin_login",
"type": "bool",
"value": false,
"description": "Allow all Jellyfin users to access jfa-go. Not recommended, add individual users in the Accounts tab instead."
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"username": {
"name": "Web Username",
"required": true,
"requires_restart": true,
"depends_false": "jellyfin_login",
"type": "text",
"value": "your username",
"description": "Username for admin page (Leave blank if using jellyfin_login)"
},
"password": {
"name": "Web Password",
"required": true,
"requires_restart": true,
"depends_false": "jellyfin_login",
"type": "password",
"value": "your password",
"description": "Password for admin page (Leave blank if using jellyfin_login)"
},
"email": {
"name": "Admin email address",
"required": false,
"requires_restart": false,
"depends_false": "jellyfin_login",
"type": "text",
"value": "example@example.com",
"description": "Address to send notifications to (Leave blank if using jellyfin_login)"
},
"debug": {
"name": "Debug logging",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Enables debug logging and exposes pprof as a route (Don't use in production!)"
},
"contact_message": {
"name": "Contact message",
"required": false,
"requires_restart": false,
"type": "text",
"value": "Need help? contact me.",
"description": "Displayed at bottom of all pages except admin"
},
"help_message": {
"name": "Help message",
"required": false,
"requires_restart": false,
"type": "text",
"value": "Enter your details to create an account.",
"description": "Displayed at top of invite form."
},
"success_message": {
"name": "Success message",
"required": false,
"requires_restart": false,
"type": "text",
"value": "Your account has been created. Click below to continue to Jellyfin.",
"description": "Displayed when a user creates an account"
},
"url_base": {
settings: rename URL base to reverse proxy subfolder
2022-01-14 17:04:17 +00:00
"name": "Reverse Proxy subfolder",
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
don't give smtp plainauth if no username & password for #141, just a guess
2021-08-26 20:03:02 +00:00
"description": "URL base for when running jfa-go with a reverse proxy in a subfolder. include preceding /, e.g \"/accounts\"."
form: add setting for changing redirect url for #167, Settings > General (Advanced) > Form success redirect URL.
2021-12-20 20:44:08 +00:00
},
"redirect_url": {
"name": "Form success redirect URL",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"advanced": true,
"description": "Set a different URL for the sign-up form to redirect the user to when they've signed up. Default to 'Public Server' or 'Server' in the Jellyfin tab."
fix GOESBUILD for newer go versions switched to 'go install' syntax. for #248.
2023-02-02 09:41:14 +00:00
},
"auto_redirect": {
"name": "Auto redirect on success",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
add option to auto redirect to jellyfin (or given link) if enabled (General>Auto redirect on success), the user will not have to click "continue" on the form or creation success page and will insted be redirected. For #242.
2023-02-02 10:34:22 +00:00
"advanced": true,
fix GOESBUILD for newer go versions switched to 'go install' syntax. for #248.
2023-02-02 09:41:14 +00:00
"description": "Navigate directly to the above URL instead of needing the user to click \"Continue\"."
admin: add setting to hide background on login for #288.
2023-10-02 09:34:07 +00:00
},
"login_appearance": {
"name": "Login screen appearance",
"required": false,
"requires_restart": false,
"type": "select",
"options": [
["clear", "Transparent"],
["opaque", "Opaque"]
],
"value": "clear",
"description": "Appearance of the Admin login screen."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
}
}
},
add optional tls/http2 support Allows for http2 server push, see the advanced section.
2021-01-15 14:41:44 +00:00
"advanced": {
"order": [],
"meta": {
"name": "Advanced",
jellyfin: retry initial connection (configurable) retries initial connection to Jellyfin 6 times, with a 10s gap between, before failing. SHould help with issues of jfa-go starting before Jellyfin. Configurable in Settings > Advanced > "Initial auth retry count/gap".
2023-10-03 08:33:56 +00:00
"description": "Advanced settings.",
"advanced": true
add optional tls/http2 support Allows for http2 server push, see the advanced section.
2021-01-15 14:41:44 +00:00
},
"settings": {
"tls": {
"name": "TLS/HTTP2",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
Fix server push and use Link header to load CSS Nginx with http2_push_preload on will convert the Link header to server pushes, so we use it to load css.
2021-01-15 18:57:12 +00:00
"description": "Enable TLS."
add optional tls/http2 support Allows for http2 server push, see the advanced section.
2021-01-15 14:41:44 +00:00
},
"tls_port": {
"name": "TLS Port",
"depends_true": "tls",
"required": false,
"requires_restart": true,
"type": "number",
"value": 8057,
"description": "Port to run TLS server on"
},
"tls_cert": {
"name": "Path to TLS Certificate",
"depends_true": "tls",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Path to .crt file. See jfa-go wiki for more info."
},
"tls_key": {
"name": "Path to TLS Key file",
"depends_true": "tls",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Path to .key file. See jfa-go wiki for more info."
jellyfin: retry initial connection (configurable) retries initial connection to Jellyfin 6 times, with a 10s gap between, before failing. SHould help with issues of jfa-go starting before Jellyfin. Configurable in Settings > Advanced > "Initial auth retry count/gap".
2023-10-03 08:33:56 +00:00
},
"auth_retry_count": {
"name": "Initial auth retry count",
"required": false,
"requires_restart": true,
"type": "number",
"value": 6,
"description": "Number of times to retry initial connection to Jellyfin before failing."
},
"auth_retry_gap": {
"name": "Initial auth retry gap (seconds)",
"required": false,
"requires_restart": true,
"type": "number",
"value": 10,
"description": "Duration in seconds to wait between connection retries."
proxy: add http/socks5 support, use for Jellyfin can be found in advanced. Currently only used for the main Jellyfin client.
2023-10-05 10:25:58 +00:00
},
"proxy": {
"name": "Use Proxy",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Whether or not to use a HTTP/SOCKS5 Proxy."
},
"proxy_protocol": {
"name": "Proxy Protocol",
"depends_true": "proxy",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["http", "HTTP"],
["socks", "SOCKS5"]
],
"value": "http",
"description": "Protocol to use for proxy connection."
},
"proxy_address": {
"name": "Proxy Address",
"depends_true": "proxy",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Proxy address, including port."
},
"proxy_user": {
"name": "Proxy Username",
"depends_true": "proxy",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Leave blank for no Authentication."
},
"proxy_password": {
"name": "Proxy Password",
"depends_true": "proxy",
"required": false,
"requires_restart": true,
"type": "password",
"value": "",
"description": "Leave blank for no Authentication."
log: add basic database write debug logging A series of settings can be found in Settings > Advanced for logging writes to the database, for each main storage object. "All" logs all writes, "Deletion" logs Delete* Calls and Write* calls where the principal data in the object (e.g. address in an EmailAddress object) is set to "".
2023-10-12 17:12:18 +00:00
},
"debug_log_emails": {
"name": "Debug Storage Logging: Emails",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
},
"debug_log_discord": {
"name": "Debug Storage Logging: Discord",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
},
"debug_log_telegram": {
"name": "Debug Storage Logging: Telegram",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
},
"debug_log_matrix": {
"name": "Debug Storage Logging: Matrix",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
},
"debug_log_invites": {
"name": "Debug Storage Logging: Invites",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
},
"debug_log_announcements": {
"name": "Debug Storage Logging: Announcements",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
},
"debug_log_expiries": {
"name": "Debug Storage Logging: User Expiries",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
},
"debug_log_profiles": {
"name": "Debug Storage Logging: Profiles",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
},
"debug_log_custom_content": {
"name": "Debug Storage Logging: Custom Message Content",
"required": false,
"requires_restart": true,
"type": "select",
"options": [
["none", "None"],
["all", "All Writes"],
["deletion", "Deletion Only*"]
],
"value": "none",
"description": "Extra debug logging for writes to the database. *: Deletion also includes blanking out major fields, e.g. an email address."
add optional tls/http2 support Allows for http2 server push, see the advanced section.
2021-01-15 14:41:44 +00:00
}
}
},
activity: add limiting settings limit to keeping n most recent logs, and/or logs younger than {n} days in settings > Activity Log.
2023-10-23 11:49:28 +00:00
"activity_log": {
"order": [],
"meta": {
"name": "Activity Log",
"description": "Settings for data retention of the activity log."
},
"settings": {
"keep_n_records": {
"name": "Number of records to keep",
"required": false,
"requires_restart": true,
"type": "number",
"value": 1000,
"description": "How many of the most recent activities to keep. Set to 0 to disable."
},
"delete_after_days": {
"name": "Delete activities older than (days):",
"required": false,
"requires_restart": true,
"type": "number",
"value": 90,
"description": "If an activity was created this many days ago, it will be deleted. Set to 0 to disable."
}
}
},
form: add CAPTCHAs Enabled in Settings > Captchas, shows a captcha on the account creation form.
2022-01-10 01:55:48 +00:00
"captcha": {
"order": [],
"meta": {
"name": "Captcha",
"description": "Settings related to user creation CAPTCHAs."
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Enable a CAPTCHA on the account creation form."
signup: add reCAPTCHA can be enabled in settings > captcha, requires a site key & secret key from google. New wiki article explains getting these. currently a little ugly looking on the page itself, hopefully fixable.
2023-06-15 16:11:27 +00:00
},
"recaptcha": {
"name": "Use Google reCAPTCHA",
"required": false,
"requires_restart": true,
"type": "bool",
config: make sure recaptcha is hidden when disabled
2023-06-26 22:24:58 +00:00
"depends_true": "enabled",
signup: add reCAPTCHA can be enabled in settings > captcha, requires a site key & secret key from google. New wiki article explains getting these. currently a little ugly looking on the page itself, hopefully fixable.
2023-06-15 16:11:27 +00:00
"value": false,
"description": "More reliable, but requires some setup. See jfa-go wiki for more info."
},
"recaptcha_site_key": {
"name": "reCAPTCHA Site Key",
"required": false,
"requires_restart": true,
"type": "text",
"depends_true": "recaptcha",
"value": "",
"description": "Site Key, see jfa-go wiki for how to acquire one."
},
"recaptcha_secret_key": {
"name": "reCAPTCHA Secret Key",
"required": false,
"requires_restart": true,
"type": "text",
"depends_true": "recaptcha",
"value": "",
"description": "Secret Key, see jfa-go wiki for how to acquire one."
},
"recaptcha_hostname": {
"name": "Hostname",
"required": false,
"requires_restart": true,
"type": "text",
"depends_true": "recaptcha",
"value": "",
"description": "Public host-name of jfa-go, e.g. \"site.com\". Don't include any subpaths."
form: add CAPTCHAs Enabled in Settings > Captchas, shows a captcha on the account creation form.
2022-01-10 01:55:48 +00:00
}
}
},
userpage: initial page login, lang, and theme work. Currently only makes a request to a hello-world type endpoint to verify auth works. Accessible at /my/account.
2023-06-16 13:43:37 +00:00
"user_page": {
"order": [],
"meta": {
settings: rename "User Page"
2023-09-08 15:50:33 +00:00
"name": "User Page/\"My Account\"",
"description": "The User Page (My Account) allows users to access and modify info directly, such as changing/adding contact methods, seeing their expiry date, sending referrals or changing their password. Password resets can also be initiated from here, given a contact method or username. ",
userpage: initial page login, lang, and theme work. Currently only makes a request to a hello-world type endpoint to verify auth works. Accessible at /my/account.
2023-06-16 13:43:37 +00:00
"depends_true": "ui|jellyfin_login"
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
referrals: enable referral for users & profiles Enabling for individual users works, as does adding a template to a profile. Removing/Disabling for both needs to be completed.
2023-09-06 21:00:44 +00:00
"requires_restart": true,
userpage: initial page login, lang, and theme work. Currently only makes a request to a hello-world type endpoint to verify auth works. Accessible at /my/account.
2023-06-16 13:43:37 +00:00
"type": "bool",
"value": true
settings: add "note" type, shows as card also comes with a "style" attribute, to apply a color to the aside it's shown in. Used in User Page/Messages to mention the customize button, and on User page w/ a critical color to mention the jellyfin login requirement.
2023-06-21 11:28:52 +00:00
},
"jellyfin_login_note": {
"name": "Note:",
"type": "note",
"value": "",
"depends_true": "enabled",
"required": "false",
userpage: mention link reset requirement
2023-06-22 20:05:54 +00:00
"description": "Jellyfin Login must be enabled to use this feature, and password resets with a link must be enabled for self-service.",
settings: add "note" type, shows as card also comes with a "style" attribute, to apply a color to the aside it's shown in. Used in User Page/Messages to mention the customize button, and on User page w/ a critical color to mention the jellyfin login requirement.
2023-06-21 11:28:52 +00:00
"style": "critical"
},
"edit_note": {
"name": "Message Cards:",
"type": "note",
"value": "",
"depends_true": "enabled",
"required": "false",
form: actually link to the my account page forgot to do this before. shown on the success modal.
2023-06-22 20:57:19 +00:00
"description": "Click the edit icon next to the \"User Page\" Setting to add custom Markdown messages that will be shown to the user. Note message cards are not private, little effort is required for anyone to view them."
referrals: 1/2 generation routes, display route, partial frontend route for generation/enabling of referral for user(s) done? the frontend is mostly done, but functionality is not there yet. Route for finding and displaying referral to user is done. Also the config option for referral is there, in user page settings.
2023-06-28 15:05:24 +00:00
},
admin: option link to my account page on login screen
2023-10-02 09:56:50 +00:00
"show_link": {
"name": "Show Link on Admin Login page",
"required": false,
"requires_restart": false,
userpage: allow manual disable of pwr through username/email/contact Checkboxes added to userpage settings allowing enabling/disabling of specific ways of starting a PWR. For #312.
2023-12-20 18:18:39 +00:00
"depends_true": "enabled",
admin: option link to my account page on login screen
2023-10-02 09:56:50 +00:00
"type": "bool",
"value": true,
"description": "Whether or not to show a link to the \"My Account\" page on the admin login screen, to direct lost users."
},
referrals: 1/2 generation routes, display route, partial frontend route for generation/enabling of referral for user(s) done? the frontend is mostly done, but functionality is not there yet. Route for finding and displaying referral to user is done. Also the config option for referral is there, in user page settings.
2023-06-28 15:05:24 +00:00
"referrals": {
"name": "User Referrals",
"required": false,
referrals: enable referral for users & profiles Enabling for individual users works, as does adding a template to a profile. Removing/Disabling for both needs to be completed.
2023-09-06 21:00:44 +00:00
"requires_restart": true,
userpage: allow manual disable of pwr through username/email/contact Checkboxes added to userpage settings allowing enabling/disabling of specific ways of starting a PWR. For #312.
2023-12-20 18:18:39 +00:00
"depends_true": "enabled",
referrals: 1/2 generation routes, display route, partial frontend route for generation/enabling of referral for user(s) done? the frontend is mostly done, but functionality is not there yet. Route for finding and displaying referral to user is done. Also the config option for referral is there, in user page settings.
2023-06-28 15:05:24 +00:00
"type": "bool",
"value": true,
"description": "Users are given their own \"invite\" to send to others."
},
"referrals_note": {
"name": "Using Referrals:",
"type": "note",
"value": "",
"depends_true": "referrals",
"required": "false",
"description": "Create an invite with your desired settings, then either assign it to a user in the accounts tab, or to a profile in settings."
userpage: allow manual disable of pwr through username/email/contact Checkboxes added to userpage settings allowing enabling/disabling of specific ways of starting a PWR. For #312.
2023-12-20 18:18:39 +00:00
},
"allow_pwr_username": {
"name": "Allow PWR with username",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "bool",
"value": true,
"description": "Allow users to start a Password Reset by inputting their username."
},
"allow_pwr_email": {
"name": "Allow PWR with email address",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "bool",
"value": true,
"description": "Allow users to start a Password Reset by inputting their email address."
},
"allow_pwr_contact_method": {
"name": "Allow PWR with Discord/Telegram/Matrix",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "bool",
"value": true,
"description": "Allow users to start a Password Reset by inputting their Discord/Telegram/Matrix username/id."
},
"pwr_note": {
"name": "PWR Methods",
"type": "note",
"depends_true": "enabled",
"value": "",
"required": "false",
"description": "Select at least one PWR initiation method. If none are selected, all will be enabled."
userpage: initial page login, lang, and theme work. Currently only makes a request to a hello-world type endpoint to verify auth works. Accessible at /my/account.
2023-06-16 13:43:37 +00:00
}
}
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"password_validation": {
"order": [],
"meta": {
"name": "Password Validation",
"description": "Password validation (minimum length, etc.)"
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": false,
"type": "bool",
"value": true
},
"min_length": {
"name": "Minimum Length",
"requires_restart": false,
"depends_true": "enabled",
"type": "text",
"value": "8"
},
"upper": {
"name": "Minimum uppercase characters",
"requires_restart": false,
"depends_true": "enabled",
"type": "text",
"value": "1"
},
"lower": {
"name": "Minimum lowercase characters",
"requires_restart": false,
"depends_true": "enabled",
"type": "text",
"value": "0"
},
"number": {
"name": "Minimum number count",
"requires_restart": false,
"depends_true": "enabled",
"type": "text",
"value": "1"
},
"special": {
"name": "Minimum number of special characters",
"requires_restart": false,
"depends_true": "enabled",
"type": "text",
"value": "0"
}
}
Display settings with hacky solution to retain order Python utility included to convert config-base.json into a new version which includes lists that define the order settings should be displayed. admin.js edited to recognize this.
2020-07-31 15:09:30 +00:00
},
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"messages": {
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"order": [],
"meta": {
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"name": "Messages/Notifications",
"description": "General settings for emails/messages."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"settings": {
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"enabled": {
"name": "Enabled",
"required": true,
"requires_restart": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"type": "bool",
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"value": true,
"description": "Enable the sending of emails/messages such as password resets, announcements, etc."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"use_24h": {
"name": "Use 24h time",
"required": false,
"requires_restart": false,
"depends_true": "method",
"type": "bool",
"value": true
},
"date_format": {
"name": "Date format",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "method",
"type": "text",
"value": "%d/%m/%y",
"description": "Date format used in emails. Follows datetime.strftime format."
},
"message": {
"name": "Help message",
"required": false,
"requires_restart": false,
"depends_true": "method",
"type": "text",
"value": "Need help? contact me.",
"description": "Message displayed at bottom of emails."
settings: add "note" type, shows as card also comes with a "style" attribute, to apply a color to the aside it's shown in. Used in User Page/Messages to mention the customize button, and on User page w/ a critical color to mention the jellyfin login requirement.
2023-06-21 11:28:52 +00:00
},
"edit_note": {
"name": "Customize Messages:",
"type": "note",
"value": "",
"depends_true": "enabled",
"required": "false",
"description": "Click the edit icon next to the \"Messages/Notifications\" Setting to customize the messages sent to users with Markdown."
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
}
}
},
"email": {
"order": [],
"meta": {
"name": "Email",
"description": "General email settings.",
"depends_true": "messages|enabled"
},
"settings": {
"language": {
"name": "Email Language",
"required": false,
"requires_restart": false,
"depends_true": "method",
"type": "select",
"options": [
["en-us", "English (US)"]
],
"value": "en-us",
"description": "Default email language. Submit a PR on github if you'd like to translate."
},
"no_username": {
"name": "Use email addresses as username",
"required": false,
"requires_restart": false,
"depends_true": "method",
"type": "bool",
"value": false,
"description": "Use email address from invite form as username on Jellyfin."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"method": {
"name": "Email method",
"required": false,
"requires_restart": false,
"type": "select",
"options": [
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
["", "Disabled"],
["smtp", "SMTP"],
["mailgun", "Mailgun"]
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
],
"value": "smtp",
"description": "Method of sending email to use."
},
"address": {
"name": "Sent from (address)",
"required": false,
"requires_restart": false,
"depends_true": "method",
"type": "email",
"value": "jellyfin@jellyf.in",
"description": "Address to send emails from"
},
"from": {
"name": "Sent from (name)",
"required": false,
"requires_restart": false,
"depends_true": "method",
"type": "text",
"value": "Jellyfin",
"description": "The name of the sender"
add plaintext email option, use text/template text/template is used on plaintext emails to avoid escaping of certain characters.
2021-02-18 18:26:23 +00:00
},
"plaintext": {
"name": "Send emails as plain text",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
add plaintext email option, use text/template text/template is used on plaintext emails to avoid escaping of certain characters.
2021-02-18 18:26:23 +00:00
"depends_true": "method",
"type": "bool",
"value": false,
"description": "Send emails as plain text instead of HTML."
email: Add option to require on sign-up for #172
2021-12-20 18:44:31 +00:00
},
"required": {
"name": "Require on sign-up",
"required": false,
"requires_restart": false,
"depends_true": "method",
"type": "bool",
"value": false,
"description": "Require an email address on sign-up."
Invites: unique email/ID requirement "Require unique ..." Settings (`require_unique` in relevant sections of config.ini) are now available for email/discord/telegram/matrix. An error is shown on the invite form if a non-unique address/ID is used. This was on my kanban without a link to an issue, so i'm guessing it was requested on Discord.
2023-02-01 15:11:10 +00:00
},
"require_unique": {
"name": "Require unique address",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Disables using the same address on multiple accounts."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
}
}
},
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"mailgun": {
"order": [],
"meta": {
"name": "Mailgun (Email)",
"description": "Mailgun API connection settings",
"depends_true": "email|method"
},
"settings": {
"api_url": {
"name": "API URL",
"required": false,
"requires_restart": false,
"type": "text",
"value": "https://api.mailgun.net..."
},
"api_key": {
"name": "API Key",
"required": false,
"requires_restart": false,
"type": "text",
"value": "your api key"
}
}
},
"smtp": {
"order": [],
"meta": {
"name": "SMTP (Email)",
"description": "SMTP Server connection settings.",
"depends_true": "email|method"
},
"settings": {
"username": {
"name": "Username",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Username for SMTP. Leave blank to user send from address as username."
},
"encryption": {
"name": "Encryption Method",
"required": false,
"requires_restart": false,
"type": "select",
"options": [
["ssl_tls", "SSL/TLS"],
["starttls", "STARTTLS"]
],
"value": "starttls",
"description": "Your email provider should provide different ports for each encryption method. Generally 465 for ssl_tls, 587 for starttls."
},
"server": {
"name": "Server address",
"required": false,
"requires_restart": false,
"type": "text",
"value": "smtp.jellyf.in",
"description": "SMTP Server address."
},
"port": {
"name": "Port",
"required": false,
"requires_restart": false,
"type": "number",
"value": 465
},
"password": {
"name": "Password",
"required": false,
"requires_restart": false,
"type": "password",
"value": "smtp password"
},
switch smtp library, add, HELLO hostname option now using xhit/go-simple-mail, as I wanted to add an option to change the hostname sent in the HELLO message but this is only possible with STARTTLS in jordan-wright/email. New option can be seen in Settings > SMTP with advanced settings turned on.
2021-10-07 11:01:42 +00:00
"hello_hostname": {
"name": "HELLO Hostname",
"required": false,
"requires_restart": false,
"advanced": true,
"type": "text",
"value": "localhost",
"description": "Hostname sent when sending HELLO to the SMTP server. Some servers don't like the default \"localhost\" value, such as smtp-relay.gmail.com."
},
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"ssl_cert": {
"name": "Path to custom SSL certificate",
"required": false,
"requires_restart": false,
"advanced": true,
"type": "text",
"value": "",
"description": "Use if your SMTP server's SSL Certificate is not trusted by the system."
Add checkbox that allows invalid SMTP certificates to be used.
2021-11-08 19:48:55 +00:00
},
"cert_validation": {
"name": "Verify certificate",
"required": false,
"requires_restart": false,
"advanced": true,
"type": "bool",
"value": true,
"description": "Warning, disabling this makes you much more vulnerable to man-in-the-middle attacks"
feat: Add SMTP authentication types to settings
2023-10-14 12:28:12 +00:00
},
"auth_type": {
"name": "Authentication type",
"required": false,
"requires_restart": false,
"advanced": false,
"type": "select",
"options": [
["0", "Plain"],
["1", "Login"],
["2", "CRAM-MD5"],
["3", "None"],
["4", "Auto"]
],
"value": 4,
"description": "SMTP authentication method"
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
}
}
},
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
"discord": {
"order": [],
"meta": {
"name": "Discord",
"description": "Settings for Discord invites/signup/notifications"
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Enable signup verification through Discord and the sending of notifications through it.\nSee the jfa-go wiki for setting up a bot."
},
messages: add option to show/hide linking on registration In each of the Discord/Telegram/Matrix sections, the "Show on user registration" option can be disabled to hide the "Link xxx" button on the registration form. This is useful is you're only using these registrations for admin purposes.
2021-11-17 16:49:26 +00:00
"show_on_reg": {
"name": "Show on user registration",
"required": false,
"requires_restart": true,
"type": "bool",
"depends_true": "enabled",
"value": true,
"description": "Allow users to link their Discord on the registration page."
},
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
"required": {
"name": "Require on sign-up",
"required": false,
messages: add option to show/hide linking on registration In each of the Discord/Telegram/Matrix sections, the "Show on user registration" option can be disabled to hide the "Link xxx" button on the registration form. This is useful is you're only using these registrations for admin purposes.
2021-11-17 16:49:26 +00:00
"requires_restart": true,
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
"depends_true": "enabled",
"type": "bool",
"value": false,
Mention wiki in Telegram/Discord/Matrix settings descriptions
2021-05-31 19:32:16 +00:00
"description": "Require Discord connection on sign-up. See the jfa-go wiki for info on setting this up."
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
},
Invites: unique email/ID requirement "Require unique ..." Settings (`require_unique` in relevant sections of config.ini) are now available for email/discord/telegram/matrix. An error is shown on the invite form if a non-unique address/ID is used. This was on my kanban without a link to an issue, so i'm guessing it was requested on Discord.
2023-02-01 15:11:10 +00:00
"require_unique": {
"name": "Require unique user",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Disables using the same user on multiple Jellyfin accounts."
},
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
"token": {
"name": "API Token",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Discord Bot API Token."
},
"start_command": {
"name": "Start command",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "text",
discord: add/move to slash commands the version of the discord library with support for this isn't necessarily stable, so normal ! commands will still be available. The user is no longer DMed for the PIN, instead they type /pin <PIN>.
2022-01-26 20:00:40 +00:00
"value": "start",
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
"description": "Command to start the user verification process."
},
PIN verification, notifications, multiple notif providers Discord, Email & Telegram can be enabled, although email is always enabled right now (will fix). Also apparently markdown hyperlinks don't work in Discord, eventually will implement something to convert them to embeds.
2021-05-21 20:35:25 +00:00
"channel": {
"name": "Channel to monitor",
"required": false,
"requires_restart": true,
Discord: Add option to provide server invite When enabled, a temporary one-use invite is created and shown to the user on the account creation form.
2021-05-23 18:50:03 +00:00
"depends_true": "enabled",
PIN verification, notifications, multiple notif providers Discord, Email & Telegram can be enabled, although email is always enabled right now (will fix). Also apparently markdown hyperlinks don't work in Discord, eventually will implement something to convert them to embeds.
2021-05-21 20:35:25 +00:00
"type": "text",
"value": "",
"description": "Only listen to commands in specified channel. Leave blank to monitor all."
},
Discord: Add option to provide server invite When enabled, a temporary one-use invite is created and shown to the user on the account creation form.
2021-05-23 18:50:03 +00:00
"provide_invite": {
"name": "Provide server invite",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "bool",
"value": false,
"description": "Generate a one-time discord server invite for the account creation form. Required Bot permission \"Create instant invite\", you may need to re-add the bot to your server after."
},
"invite_channel": {
"name": "Invite channel",
"required": false,
"requires_restart": true,
"depends_true": "provide_invite",
"type": "text",
"value": "",
"description": "Channel to invite new users to."
},
discord: add role to user on signup This requires an extra permission, so you'll have to modify your bot settings, kick it from your server and re-add it for this to work. The role you select must also be lower in hierarchy than the bot's group.
2022-01-13 22:34:47 +00:00
"apply_role": {
"name": "Apply Role on connection",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "select",
"options": [
["", "None"]
],
"value": "",
"description": "Add the selected role to a user when they sign up."
},
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
"language": {
"name": "Language",
"required": false,
"requires_restart": false,
"depends_true": "enabled",
"type": "select",
"options": [
["en-us", "English (US)"]
],
"value": "en-us",
"description": "Default Discord message language. Visit weblate if you'd like to translate."
}
}
},
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"telegram": {
"order": [],
"meta": {
"name": "Telegram",
Mention wiki in Telegram/Discord/Matrix settings descriptions
2021-05-31 19:32:16 +00:00
"description": "Settings for Telegram signup/notifications. See the jfa-go wiki for info on setting this up."
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
mention wiki in telegram settings description
2021-05-07 22:36:46 +00:00
"description": "Enable signup verification through Telegram and the sending of notifications through it.\nSee the jfa-go wiki for setting up a bot."
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
},
messages: add option to show/hide linking on registration In each of the Discord/Telegram/Matrix sections, the "Show on user registration" option can be disabled to hide the "Link xxx" button on the registration form. This is useful is you're only using these registrations for admin purposes.
2021-11-17 16:49:26 +00:00
"show_on_reg": {
"name": "Show on user registration",
"required": false,
"requires_restart": true,
"type": "bool",
"depends_true": "enabled",
"value": true,
"description": "Allow users to link their Telegram on the registration page."
},
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"required": {
"name": "Require on sign-up",
"required": false,
"required_restart": true,
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
"depends_true": "enabled",
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"type": "bool",
"value": false,
"description": "Require telegram connection on sign-up."
},
Invites: unique email/ID requirement "Require unique ..." Settings (`require_unique` in relevant sections of config.ini) are now available for email/discord/telegram/matrix. An error is shown on the invite form if a non-unique address/ID is used. This was on my kanban without a link to an issue, so i'm guessing it was requested on Discord.
2023-02-01 15:11:10 +00:00
"require_unique": {
"name": "Require unique user",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Disables using the same user on multiple Jellyfin accounts."
},
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"token": {
"name": "API Token",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Telegram Bot API Token."
},
"language": {
"name": "Language",
"required": false,
"requires_restart": false,
"depends_true": "enabled",
"type": "select",
"options": [
["en-us", "English (US)"]
],
"value": "en-us",
"description": "Default telegram message language. Visit weblate if you'd like to translate."
}
}
},
Matrix: Setup bot, add PIN verification PIN is verified but not used currently. Works a little different than the others, you input your matrix user ID and then the PIN is sent to you. The bot doesn't support E2EE, so the bot being the first one to message ensures the chat is unencrypted.
2021-05-29 16:43:11 +00:00
"matrix": {
"order": [],
"meta": {
"name": "Matrix",
Mention wiki in Telegram/Discord/Matrix settings descriptions
2021-05-31 19:32:16 +00:00
"description": "Settings for Matrix invites/signup/notifications. See the jfa-go wiki for info on setting this up."
Matrix: Setup bot, add PIN verification PIN is verified but not used currently. Works a little different than the others, you input your matrix user ID and then the PIN is sent to you. The bot doesn't support E2EE, so the bot being the first one to message ensures the chat is unencrypted.
2021-05-29 16:43:11 +00:00
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Enable signup verification through Matrix and the sending of notifications through it.\nSee the jfa-go wiki for setting up a bot."
},
messages: add option to show/hide linking on registration In each of the Discord/Telegram/Matrix sections, the "Show on user registration" option can be disabled to hide the "Link xxx" button on the registration form. This is useful is you're only using these registrations for admin purposes.
2021-11-17 16:49:26 +00:00
"show_on_reg": {
"name": "Show on user registration",
"required": false,
"requires_restart": true,
"type": "bool",
"depends_true": "enabled",
"value": true,
"description": "Allow users to link their Matrix on the registration page."
},
Matrix: Setup bot, add PIN verification PIN is verified but not used currently. Works a little different than the others, you input your matrix user ID and then the PIN is sent to you. The bot doesn't support E2EE, so the bot being the first one to message ensures the chat is unencrypted.
2021-05-29 16:43:11 +00:00
"required": {
"name": "Require on sign-up",
"required": false,
"required_restart": true,
"depends_true": "enabled",
"type": "bool",
"value": false,
"description": "Require Matrix connection on sign-up."
},
Invites: unique email/ID requirement "Require unique ..." Settings (`require_unique` in relevant sections of config.ini) are now available for email/discord/telegram/matrix. An error is shown on the invite form if a non-unique address/ID is used. This was on my kanban without a link to an issue, so i'm guessing it was requested on Discord.
2023-02-01 15:11:10 +00:00
"require_unique": {
"name": "Require unique user",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Disables using the same user on multiple Jellyfin accounts."
},
Matrix: Setup bot, add PIN verification PIN is verified but not used currently. Works a little different than the others, you input your matrix user ID and then the PIN is sent to you. The bot doesn't support E2EE, so the bot being the first one to message ensures the chat is unencrypted.
2021-05-29 16:43:11 +00:00
"homeserver": {
"name": "Home Server URL",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Matrix Home server URL."
},
"token": {
"name": "Access Token",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Matrix Bot API Token."
},
"user_id": {
"name": "Bot User ID",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "User ID of bot account (Example: @jfa-bot:riot.im)"
},
Matrix: Connect on accounts tab, customizable chat topic
2021-05-30 10:47:41 +00:00
"topic": {
"name": "Chat topic",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "text",
"value": "Jellyfin notifications",
"description": "Topic of Matrix private chats."
},
Matrix: Setup bot, add PIN verification PIN is verified but not used currently. Works a little different than the others, you input your matrix user ID and then the PIN is sent to you. The bot doesn't support E2EE, so the bot being the first one to message ensures the chat is unencrypted.
2021-05-29 16:43:11 +00:00
"language": {
"name": "Language",
"required": false,
"requires_restart": false,
"depends_true": "enabled",
"type": "select",
"options": [
["en-us", "English (US)"]
],
"value": "en-us",
"description": "Default Matrix message language. Visit weblate if you'd like to translate."
matrix: E2EE as build option since this is so broken and requires CGO deps, E2EE support is now only included with "make E2EE=on ...". The option to enable will then appear in settings.
2021-07-16 14:41:08 +00:00
},
"encryption": {
"name": "End-to-end encryption (experimental)",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"advanced": true,
"type": "bool",
"value": false,
"description": "Enable end-to-end encryption for messages. Very experimental, currently does not support receiving commands (e.g !lang)."
Matrix: Setup bot, add PIN verification PIN is verified but not used currently. Works a little different than the others, you input your matrix user ID and then the PIN is sent to you. The bot doesn't support E2EE, so the bot being the first one to message ensures the chat is unencrypted.
2021-05-29 16:43:11 +00:00
}
}
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"password_resets": {
"order": [],
"meta": {
"name": "Password Resets",
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
"description": "Settings for the password reset handler.",
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"depends_true": "messages|enabled"
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": true,
"description": "Enable to store provided email addresses, monitor Jellyfin directory for pw-resets, and send reset pins"
},
settings: link to new PWR wiki article in note
2023-09-09 15:02:39 +00:00
"pwr_note": {
"name": "Setup:",
"type": "note",
"value": "",
"depends_true": "enabled",
"required": "false",
"description": "There are multiple ways password resets can be set up. See the <a href=\"https://wiki.jfa-go.com/docs/pwr/\" target=\"_blank\">wiki page</a> for more information."
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"watch_directory": {
"name": "Jellyfin directory",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "text",
"value": "/path/to/jellyfin",
"description": "Path to the folder Jellyfin puts password-reset files."
},
add password reset link option When enabled (in Settings > Password Resets), a magic link will be sent instead of a PIN when the user tries reset their password. By doing this the user doesn't have to keep the Jellyfin tab open to enter the code.
2021-03-30 21:41:28 +00:00
"link_reset": {
ombi: reset password when using pwr links When password reset links are enabled, the ombi password will be reset to the PIN along with Jellyfin.
2021-05-02 12:23:59 +00:00
"name": "Use reset link instead of PIN (Required for Ombi)",
add password reset link option When enabled (in Settings > Password Resets), a magic link will be sent instead of a PIN when the user tries reset their password. By doing this the user doesn't have to keep the Jellyfin tab open to enter the code.
2021-03-30 21:41:28 +00:00
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "bool",
"value": false,
ombi: reset password when using pwr links When password reset links are enabled, the ombi password will be reset to the PIN along with Jellyfin.
2021-05-02 12:23:59 +00:00
"description": "Send users a link to reset their password instead of a PIN. Must be enabled to reset Ombi password at the same time as the Jellyfin password."
add password reset link option When enabled (in Settings > Password Resets), a magic link will be sent instead of a PIN when the user tries reset their password. By doing this the user doesn't have to keep the Jellyfin tab open to enter the code.
2021-03-30 21:41:28 +00:00
},
PWR: Add option to set new password from magic link For #103. Enable in Settings > Password Resets. Also changes the user's ombi password.
2021-06-07 12:46:46 +00:00
"set_password": {
"name": "Set password through link",
"required": false,
"requires_restart": true,
"depends_true": "link_reset",
"type": "bool",
"value": false,
"description": "Instead of automatically setting the user's password to the PIN, allow them to set a new password through the reset link."
},
settings: add redundant URL base for pwr having it under "Invite Emails" when they weren't in use was confusing. If only one is set in the config file, it'll be used for both.
2021-07-27 15:48:24 +00:00
"url_base": {
"name": "URL Base",
"required": true,
"requires_restart": false,
"depends_true": "link_reset",
"type": "text",
"value": "http://accounts.jellyf.in:8056",
"description": "Base URL for jfa-go. You can leave this if you have one set in \"Invite Emails\". This is necessary because using a reverse proxy means the program has no way of knowing the URL itself."
},
add password reset link option When enabled (in Settings > Password Resets), a magic link will be sent instead of a PIN when the user tries reset their password. By doing this the user doesn't have to keep the Jellyfin tab open to enter the code.
2021-03-30 21:41:28 +00:00
"language": {
"name": "Default reset link language",
"required": false,
"requires_restart": true,
"depends_true": "link_reset",
"type": "select",
"options": [
["en-us", "English (US)"]
],
"value": "en-us",
"description": "Default language for password reset success screen."
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"email_html": {
"name": "Custom email (HTML)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to custom email html"
},
"email_text": {
"name": "Custom email (plaintext)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to custom email in plain text"
},
"subject": {
"name": "Email subject",
"required": false,
"requires_restart": false,
"depends_true": "enabled",
"type": "text",
add optional welcome email for new users When enabled, an email with the server URL and username will be sent to created users. Requested in #38.
2021-01-24 15:19:58 +00:00
"value": "",
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"description": "Subject of password reset emails."
}
}
},
"invite_emails": {
"order": [],
"meta": {
"name": "Invite emails",
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
"description": "Settings for sending invites directly to users.",
"depends_true": "email|method"
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": false,
"type": "bool",
"value": true
},
"email_html": {
"name": "Custom email (HTML)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to custom email HTML"
},
"email_text": {
"name": "Custom email (plaintext)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to custom email in plain text"
},
"subject": {
"name": "Email subject",
"required": true,
"requires_restart": false,
"depends_true": "enabled",
"type": "text",
add optional welcome email for new users When enabled, an email with the server URL and username will be sent to created users. Requested in #38.
2021-01-24 15:19:58 +00:00
"value": "",
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"description": "Subject of invite emails."
},
"url_base": {
"name": "URL Base",
"required": true,
"requires_restart": false,
"depends_true": "enabled",
"type": "text",
settings: add redundant URL base for pwr having it under "Invite Emails" when they weren't in use was confusing. If only one is set in the config file, it'll be used for both.
2021-07-27 15:48:24 +00:00
"value": "http://accounts.jellyf.in:8056",
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"description": "Base URL for jfa-go. This is necessary because using a reverse proxy means the program has no way of knowing the URL itself."
}
}
},
settings: include custom email template setting
2021-07-14 15:48:50 +00:00
"template_email": {
"order": [],
"meta": {
"name": "Custom email template",
"description": "Settings for the template used for announcements & custom messages. HTML should include {{ .text }}, Plaintext should include {{ .plaintext }}, and either can have {{ .message }} to include the contact message.",
"advanced": true
},
"settings": {
"email_html": {
"name": "Custom template email (HTML)",
"required": false,
"requires_restart": false,
"advanced": true,
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to custom email HTML template for announcements/custom messages."
},
"email_text": {
"name": "Custom template email (plaintext)",
"required": false,
"requires_restart": false,
"advanced": true,
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to custom email text template for announcements/custom messages."
}
}
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"notifications": {
"order": [],
"meta": {
"name": "Notifications",
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
"description": "Notification related settings.",
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"depends_true": "messages|enabled"
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"settings": {
"enabled": {
"name": "Enabled",
"required": "false",
"requires_restart": true,
"type": "bool",
"value": true,
"description": "Enabling adds optional toggles to invites to notify on expiry and user creation."
},
"expiry_html": {
"name": "Expiry email (HTML)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to expiry notification email HTML."
},
"expiry_text": {
"name": "Expiry email (Plaintext)",
"required": false,
"requires_restart": "false",
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to expiry notification email in plaintext."
},
"created_html": {
"name": "User created email (HTML)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to user creation notification email HTML."
},
"created_text": {
"name": "User created email (Plaintext)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"depends_true": "enabled",
"type": "text",
"value": "",
"description": "Path to user creation notification email in plaintext."
}
}
},
"ombi": {
"order": [],
"meta": {
"name": "Ombi Integration",
Ombi: Integrate with profiles, Retire user defaults NOTE: If you previously used the Ombi integration, New ombi users won't be created until you set this up. Ombi settings can be added to a profile in Settings > User Profiles. The "Modify settings" options will now apply to ombi if the selected profile has ombi settings.
2021-11-13 18:53:53 +00:00
"description": "Connect to Ombi to automatically create both Ombi and Jellyfin accounts for new users. You'll need to add a ombi template to an existing User Profile for accounts to be created, which you can do by refreshing then checking Settings > User Profiles. To handle password resets for Ombi & Jellyfin, enable \"Use reset link instead of PIN\"."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Enable to create an Ombi account for new Jellyfin users"
},
"server": {
"name": "URL",
"required": false,
"requires_restart": true,
"type": "text",
"value": "localhost:5000",
"depends_true": "enabled",
"description": "Ombi server URL, including http(s)://."
},
"api_key": {
"name": "API Key",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"depends_true": "enabled",
"description": "API Key. Get this from the first tab in Ombi settings."
}
}
},
backups: add backup daemon to run every n minutes, keep x most recent backups
2023-12-21 13:03:16 +00:00
"backups": {
"order": [],
"meta": {
"name": "Backups",
"description": "Settings for database backups."
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Enable to generate database backups on a schedule."
},
"path": {
"name": "Backup Path",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Path to directory to store backups in. defaults to <data_directory>/backups."
},
"every_n_minutes": {
"name": "Backup frequency (Minutes)",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "number",
"value": 1440,
"description": "Backup after this many minutes has passed since the last. Resets every restart."
},
"keep_n_backups": {
"name": "Number of backups to keep",
"required": false,
"requires_restart": true,
"depends_true": "enabled",
"type": "number",
"value": 20,
"description": "Number of most recent backups to keep. Once this is hit, the oldest backup will be deleted before doing a new one."
}
}
},
add optional welcome email for new users When enabled, an email with the server URL and username will be sent to created users. Requested in #38.
2021-01-24 15:19:58 +00:00
"welcome_email": {
"order": [],
"meta": {
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"name": "Welcome Message",
"description": "Optionally send a welcome message to new users with the Jellyfin URL and their username.",
"depends_true": "messages|enabled"
add optional welcome email for new users When enabled, an email with the server URL and username will be sent to created users. Requested in #38.
2021-01-24 15:19:58 +00:00
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false,
"description": "Enable to send welcome emails to new users."
},
"subject": {
"name": "Email subject",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Subject of welcome emails."
},
"email_html": {
"name": "Custom email (HTML)",
"required": false,
Add optional email confirmation If enabled, a confirmation email will be sent before the user can create their account.
2021-01-30 19:19:12 +00:00
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Add optional email confirmation If enabled, a confirmation email will be sent before the user can create their account.
2021-01-30 19:19:12 +00:00
"type": "text",
"value": "",
"description": "Path to custom email html"
},
"email_text": {
"name": "Custom email (plaintext)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Add optional email confirmation If enabled, a confirmation email will be sent before the user can create their account.
2021-01-30 19:19:12 +00:00
"type": "text",
"value": "",
"description": "Path to custom email in plain text"
}
}
},
"email_confirmation": {
"order": [],
"meta": {
"name": "Email confirmation",
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
"description": "If enabled, a user will be sent an email confirmation link to ensure their password is right before they can make an account.",
"depends_true": "email|method"
Add optional email confirmation If enabled, a confirmation email will be sent before the user can create their account.
2021-01-30 19:19:12 +00:00
},
"settings": {
"enabled": {
"name": "Enabled",
"required": false,
"requires_restart": true,
"type": "bool",
"value": false
},
"subject": {
"name": "Email subject",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Subject of email confirmation emails."
},
"email_html": {
"name": "Custom email (HTML)",
"required": false,
add optional welcome email for new users When enabled, an email with the server URL and username will be sent to created users. Requested in #38.
2021-01-24 15:19:58 +00:00
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
add optional welcome email for new users When enabled, an email with the server URL and username will be sent to created users. Requested in #38.
2021-01-24 15:19:58 +00:00
"type": "text",
"value": "",
"description": "Path to custom email html"
},
"email_text": {
"name": "Custom email (plaintext)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
add optional welcome email for new users When enabled, an email with the server URL and username will be sent to created users. Requested in #38.
2021-01-24 15:19:58 +00:00
"type": "text",
"value": "",
"description": "Path to custom email in plain text"
}
}
},
implement user expiry functionality All works now, but i'll add a field on the accounts tab for users with an expiry, as well as a 'disabled' badge.
2021-02-28 15:41:06 +00:00
"user_expiry": {
"order": [],
"meta": {
"name": "User Expiry",
"description": "When set on an invite, users will be deleted or disabled a specified amount of time after they create their account."
},
"settings": {
"behaviour": {
"name": "Behaviour",
"required": false,
"requires_restart": false,
"type": "select",
"options": [
["delete_user", "Delete user"],
["disable_user", "Disable user"]
],
"value": "disable_user",
"description": "Whether to delete or disable users on expiry."
},
"send_email": {
"name": "Send email",
"required": false,
"requires_restart": false,
"type": "bool",
"value": true,
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"depends_true": "messages|enabled",
implement user expiry functionality All works now, but i'll add a field on the accounts tab for users with an expiry, as well as a 'disabled' badge.
2021-02-28 15:41:06 +00:00
"description": "Send an email when a user's account expires."
},
"subject": {
"name": "Email subject",
"required": false,
"requires_restart": false,
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"depends_true": "messages|enabled",
implement user expiry functionality All works now, but i'll add a field on the accounts tab for users with an expiry, as well as a 'disabled' badge.
2021-02-28 15:41:06 +00:00
"type": "text",
"value": "",
"description": "Subject of user expiry emails."
},
"email_html": {
"name": "Custom email (HTML)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"depends_true": "messages|enabled",
implement user expiry functionality All works now, but i'll add a field on the accounts tab for users with an expiry, as well as a 'disabled' badge.
2021-02-28 15:41:06 +00:00
"type": "text",
"value": "",
"description": "Path to custom email html"
},
"email_text": {
"name": "Custom email (plaintext)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"depends_true": "messages|enabled",
implement user expiry functionality All works now, but i'll add a field on the accounts tab for users with an expiry, as well as a 'disabled' badge.
2021-02-28 15:41:06 +00:00
"type": "text",
"value": "",
"description": "Path to custom email in plain text"
}
}
},
accounts: add user enable/disable & emails
2021-04-12 20:28:36 +00:00
"disable_enable": {
"order": [],
"meta": {
"name": "Account Disabling/Enabling",
"description": "Subject/email files for account disabling/enabling emails.",
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"depends_true": "messages|enabled"
accounts: add user enable/disable & emails
2021-04-12 20:28:36 +00:00
},
"settings": {
"subject_disabled": {
"name": "Email subject (Disabled)",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Subject of account disabling emails."
},
"subject_enabled": {
"name": "Email subject (Enabled)",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Subject of account enabling emails."
},
"disabled_html": {
"name": "Custom disabling email (HTML)",
"required": false,
"requires_restart": false,
"advanced": true,
"type": "text",
"value": "",
"description": "Path to custom email html"
},
"disabled_text": {
"name": "Custom disabling email (plaintext)",
"required": false,
"requires_restart": false,
"advanced": true,
"type": "text",
"value": "",
"description": "Path to custom email in plain text"
},
"enabled_html": {
"name": "Custom enabling email (HTML)",
"required": false,
"requires_restart": false,
"advanced": true,
"type": "text",
"value": "",
"description": "Path to custom email html"
},
"enabled_text": {
"name": "Custom enabling email (plaintext)",
"required": false,
"requires_restart": false,
"advanced": true,
"type": "text",
"value": "",
"description": "Path to custom email in plain text"
}
}
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"deletion": {
"order": [],
"meta": {
"name": "Account Deletion",
add inter-section dependency for settings Currently used to hide all email sections when [email]/method is blank (disabled).
2021-01-31 18:50:04 +00:00
"description": "Subject/email files for account deletion emails.",
Split some settings into new "messages" section Most email dependant sections now depend on this. Also renamed more email things.
2021-05-07 20:53:29 +00:00
"depends_true": "messages|enabled"
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"settings": {
"subject": {
"name": "Email subject",
"required": false,
"requires_restart": false,
"type": "text",
split some strings into common file; use lang file to setup page
2021-01-25 21:26:54 +00:00
"value": "",
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"description": "Subject of account deletion emails."
},
"email_html": {
"name": "Custom email (HTML)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"type": "text",
"value": "",
"description": "Path to custom email html"
},
"email_text": {
"name": "Custom email (plaintext)",
"required": false,
"requires_restart": false,
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"advanced": true,
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"type": "text",
"value": "",
"description": "Path to custom email in plain text"
}
}
},
"files": {
"order": [],
"meta": {
"name": "File Storage",
add advanced setting type with toggle in settings
2021-03-15 22:51:17 +00:00
"description": "Optional settings for changing storage locations.",
"advanced": true
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
},
"settings": {
"invites": {
"name": "Invite Storage",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Location of stored invites (json)."
},
PWR: Add option to set new password from magic link For #103. Enable in Settings > Password Resets. Also changes the user's ombi password.
2021-06-07 12:46:46 +00:00
"password_resets": {
"name": "Password Resets",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Location of stored non-Jellyfin password resets (json)."
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"emails": {
"name": "Email Addresses",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Location of stored email addresses (json)."
},
implement user expiry functionality All works now, but i'll add a field on the accounts tab for users with an expiry, as well as a 'disabled' badge.
2021-02-28 15:41:06 +00:00
"users": {
"name": "User storage",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Stores users temporarily when a user expiry is set."
},
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
"ombi_template": {
"name": "Ombi user template",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Location of stored Ombi user template."
},
"user_profiles": {
"name": "User Profiles",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Location of stored user profiles (encompasses template and configuration and displayprefs) (json)"
},
"html_templates": {
"name": "Custom HTML Template Directory",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
"description": "Path to directory containing custom versions of web ui pages. See wiki for more info."
Use fs for language, add lang_files option The local app translations are loaded, and then if [files]/lang_files is provided (a directory containing custom translations), any found inside it are loaded over top. This makes customizing much easier.
2021-02-01 17:39:19 +00:00
},
"lang_files": {
"name": "Custom language files directory",
"required": false,
"requires_restart": true,
"type": "text",
"value": "",
use embed.fs wrapper for langFS so lang/ is not needed in paths [files]lang_files is now the path to the lang directory, not path to a directory containing it.
2021-02-02 15:19:43 +00:00
"description": "The path to a directory which following the same form as the internal 'lang/' directory. See GitHub for more info."
Implement email template generation Variables are surrounded by {}, and initial (default) templates are generated on demand from the plaintext version of emails. The custom emails are intended to only be used if the user actually changes them, as they lose the features of the default ones, such as tables.
2021-02-19 21:38:20 +00:00
},
"custom_emails": {
"name": "Custom email content",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "JSON file generated by program in settings, different from email_html/email_text. See wiki for more info."
almost complete telegram user verification When signing up, the user is given a pin code which they send to a telegram bot. This provides user verification, but more importantly allows the bot to message the user, as the Telegram API requires the user to interact with the bot before it can do the opposite. The bot should recognize the correct language, but a /lang command is also provided to change it. The verification process is pretty much functional but ui is still broken, and it isn't properly integrated yet.
2021-05-07 00:08:12 +00:00
},
userpage: implement login message card Shares code with custom emails, so most related functions have had a %s/Email/Message/g. Press the edit button on the user page setting to add a message.
2023-06-20 20:43:25 +00:00
"custom_user_page_content": {
"name": "Custom user page content",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "JSON file generated by program in settings, containing user page messages. See wiki for more info."
},
almost complete telegram user verification When signing up, the user is given a pin code which they send to a telegram bot. This provides user verification, but more importantly allows the bot to message the user, as the Telegram API requires the user to interact with the bot before it can do the opposite. The bot should recognize the correct language, but a /lang command is also provided to change it. The verification process is pretty much functional but ui is still broken, and it isn't properly integrated yet.
2021-05-07 00:08:12 +00:00
"telegram_users": {
"name": "Telegram users",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Stores telegram user IDs and language preferences."
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
},
Matrix: Setup bot, add PIN verification PIN is verified but not used currently. Works a little different than the others, you input your matrix user ID and then the PIN is sent to you. The bot doesn't support E2EE, so the bot being the first one to message ensures the chat is unencrypted.
2021-05-29 16:43:11 +00:00
"matrix_users": {
"name": "Matrix users",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Stores matrix user IDs and language preferences."
},
matrix: end-to-end encryption by default Existing chats will remain unencrypted but new ones will be.
2021-07-13 18:02:16 +00:00
"matrix_sql": {
"name": "Matrix encryption DB",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Stores cryptographic material for Matrix end-to-end encryption."
},
Discord: Start bot, add !start and pin validity check The bot should be created by the admin and added to a discord server mutual to the intended new user(s). On !start in the server, communication is moved to DMs. Currently !start works, and validity of a given PIN is checked although nothing it done with this yet.
2021-05-17 22:42:33 +00:00
"discord_users": {
"name": "Discord users",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Stores discord user IDs and language preferences."
accounts: add templates for announcements you can now save announcements as templates, and then use them later by hovering over the "Announce" button, as well as delete them.
2021-07-10 15:43:27 +00:00
},
"announcements": {
"name": "Announcement templates",
"required": false,
"requires_restart": false,
"type": "text",
"value": "",
"description": "Stores custom announcement templates."
Merge a17t-redesign, kinda ts-ify setup.js the web ui has been redesigned with the a17t toolkit, which imo looks a lot better than bootstrap. This also brought a complete rework of the web code, which now makes a lot more sense hopefully. the setup page is still stuck with bootstrap, its not much of a priority but i'll rewrite it eventually.
2021-01-05 18:16:23 +00:00
}
}
Display settings with hacky solution to retain order Python utility included to convert config-base.json into a new version which includes lists that define the order settings should be displayed. admin.js edited to recognize this.
2020-07-31 15:09:30 +00:00
}
}
}
Reference in New Issue Copy Permalink