lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enhancement: support disable regular login

Browse Source
This commit is contained in:
shamoon 2024-02-18 21:39:54 -08:00
parent 90b4691f16
commit ced75104de
6 changed files with 73 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/advanced_usage.md
View File

@ -692,3 +692,7 @@ PAPERLESS_SOCIALACCOUNT_PROVIDERS='
``` ```
More details about configuration option for various providers can be found in the [allauth documentation](https://docs.allauth.org/en/latest/socialaccount/providers/index.html#provider-specifics). More details about configuration option for various providers can be found in the [allauth documentation](https://docs.allauth.org/en/latest/socialaccount/providers/index.html#provider-specifics).
### Disabling Regular Login
Once external auth is set up, 'regular' login can be disabled with the [PAPERLESS_DISABLE_REGULAR_LOGIN](configuration.md#PAPERLESS_DISABLE_REGULAR_LOGIN) setting.

6
docs/configuration.md
View File

@ -572,6 +572,12 @@ system. See the corresponding
Defaults to 'https' Defaults to 'https'
#### [`PAPERLESS_DISABLE_REGULAR_LOGIN=<bool>`](#PAPERLESS_DISABLE_REGULAR_LOGIN) {#PAPERLESS_DISABLE_REGULAR_LOGIN}
: Disables the regular frontend username / password login, i.e. once you have setup SSO. Note that the Django admin login cannot be disabled.
Defaults to False
## OCR settings {#ocr} ## OCR settings {#ocr}
Paperless uses [OCRmyPDF](https://ocrmypdf.readthedocs.io/en/latest/) Paperless uses [OCRmyPDF](https://ocrmypdf.readthedocs.io/en/latest/)

1
src/documents/context_processors.py
View File

@ -5,4 +5,5 @@ def settings(request):
return { return {
"EMAIL_ENABLED": django_settings.EMAIL_HOST != "localhost" "EMAIL_ENABLED": django_settings.EMAIL_HOST != "localhost"
or django_settings.EMAIL_HOST_USER != "", or django_settings.EMAIL_HOST_USER != "",
"DISABLE_REGULAR_LOGIN": django_settings.DISABLE_REGULAR_LOGIN,
} }

40
src/documents/templates/account/login.html
View File

@ -58,29 +58,33 @@
{% translate "Share link has expired." %} {% translate "Share link has expired." %}
</div> </div>
{% endif %} {% endif %}
{% translate "Username" as i18n_username %} {% if not DISABLE_REGULAR_LOGIN %}
{% translate "Password" as i18n_password %} {% translate "Username" as i18n_username %}
<div class="form-floating"> {% translate "Password" as i18n_password %}
<input type="text" name="login" id="inputUsername" placeholder="{{ i18n_username }}" class="form-control" autocorrect="off" autocapitalize="none" required autofocus> <div class="form-floating">
<label for="inputUsername">{{ i18n_username }}</label> <input type="text" name="login" id="inputUsername" placeholder="{{ i18n_username }}" class="form-control" autocorrect="off" autocapitalize="none" required autofocus>
</div> <label for="inputUsername">{{ i18n_username }}</label>
<div class="form-floating"> </div>
<input type="password" name="password" id="inputPassword" placeholder="{{ i18n_password }}" class="form-control" required> <div class="form-floating">
<label for="inputPassword">{{ i18n_password }}</label> <input type="password" name="password" id="inputPassword" placeholder="{{ i18n_password }}" class="form-control" required>
</div> <label for="inputPassword">{{ i18n_password }}</label>
<div class="d-grid mt-3"> </div>
<button class="btn btn-lg btn-primary" type="submit">{% translate "Sign in" %}</button> <div class="d-grid mt-3">
</div> <button class="btn btn-lg btn-primary" type="submit">{% translate "Sign in" %}</button>
{% if EMAIL_ENABLED %} </div>
<div class="d-grid mt-3"> {% if EMAIL_ENABLED %}
<a class="btn btn-link" href="{% url 'account_reset_password' %}">{% translate "Forgot your password?" %}</a> <div class="d-grid mt-3">
</div> <a class="btn btn-link" href="{% url 'account_reset_password' %}">{% translate "Forgot your password?" %}</a>
</div>
{% endif %}
{% endif %} {% endif %}
</form> </form>
{% load allauth socialaccount %} {% load allauth socialaccount %}
{% get_providers as socialaccount_providers %} {% get_providers as socialaccount_providers %}
{% if socialaccount_providers %} {% if socialaccount_providers %}
<p class="mt-3">{% translate "or sign in via" %}</p> {% if not DISABLE_REGULAR_LOGIN %}
<p class="mt-3">{% translate "or sign in via" %}</p>
{% endif %}
<ul class="m-0 p-0"> <ul class="m-0 p-0">
{% for provider in socialaccount_providers %} {% for provider in socialaccount_providers %}
{% if provider.id == "openid" %} {% if provider.id == "openid" %}

76
src/locale/en_US/LC_MESSAGES/django.po
View File

@ -2,7 +2,7 @@ msgid ""
msgstr "" msgstr ""
"Project-Id-Version: paperless-ngx\n" "Project-Id-Version: paperless-ngx\n"
"Report-Msgid-Bugs-To: \n" "Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-02-14 16:47-0800\n" "POT-Creation-Date: 2024-02-18 22:27-0800\n"
"PO-Revision-Date: 2022-02-17 04:17\n" "PO-Revision-Date: 2022-02-17 04:17\n"
"Last-Translator: \n" "Last-Translator: \n"
"Language-Team: English\n" "Language-Team: English\n"
@ -806,24 +806,24 @@ msgstr ""
msgid "Share link has expired." msgid "Share link has expired."
msgstr "" msgstr ""
#: documents/templates/account/login.html:61 #: documents/templates/account/login.html:62
#: documents/templates/socialaccount/signup.html:56 #: documents/templates/socialaccount/signup.html:56
msgid "Username" msgid "Username"
msgstr "" msgstr ""
#: documents/templates/account/login.html:62 #: documents/templates/account/login.html:63
msgid "Password" msgid "Password"
msgstr "" msgstr ""
#: documents/templates/account/login.html:72 #: documents/templates/account/login.html:73
msgid "Sign in" msgid "Sign in"
msgstr "" msgstr ""
#: documents/templates/account/login.html:76 #: documents/templates/account/login.html:77
msgid "Forgot your password?" msgid "Forgot your password?"
msgstr "" msgstr ""
#: documents/templates/account/login.html:83 #: documents/templates/account/login.html:86
msgid "or sign in via" msgid "or sign in via"
msgstr "" msgstr ""
@ -1120,131 +1120,131 @@ msgstr ""
msgid "paperless application settings" msgid "paperless application settings"
msgstr "" msgstr ""
#: paperless/settings.py:642 #: paperless/settings.py:644
msgid "English (US)" msgid "English (US)"
msgstr "" msgstr ""
#: paperless/settings.py:643 #: paperless/settings.py:645
msgid "Arabic" msgid "Arabic"
msgstr "" msgstr ""
#: paperless/settings.py:644 #: paperless/settings.py:646
msgid "Afrikaans" msgid "Afrikaans"
msgstr "" msgstr ""
#: paperless/settings.py:645 #: paperless/settings.py:647
msgid "Belarusian" msgid "Belarusian"
msgstr "" msgstr ""
#: paperless/settings.py:646 #: paperless/settings.py:648
msgid "Bulgarian" msgid "Bulgarian"
msgstr "" msgstr ""
#: paperless/settings.py:647 #: paperless/settings.py:649
msgid "Catalan" msgid "Catalan"
msgstr "" msgstr ""
#: paperless/settings.py:648 #: paperless/settings.py:650
msgid "Czech" msgid "Czech"
msgstr "" msgstr ""
#: paperless/settings.py:649 #: paperless/settings.py:651
msgid "Danish" msgid "Danish"
msgstr "" msgstr ""
#: paperless/settings.py:650 #: paperless/settings.py:652
msgid "German" msgid "German"
msgstr "" msgstr ""
#: paperless/settings.py:651 #: paperless/settings.py:653
msgid "Greek" msgid "Greek"
msgstr "" msgstr ""
#: paperless/settings.py:652 #: paperless/settings.py:654
msgid "English (GB)" msgid "English (GB)"
msgstr "" msgstr ""
#: paperless/settings.py:653 #: paperless/settings.py:655
msgid "Spanish" msgid "Spanish"
msgstr "" msgstr ""
#: paperless/settings.py:654 #: paperless/settings.py:656
msgid "Finnish" msgid "Finnish"
msgstr "" msgstr ""
#: paperless/settings.py:655 #: paperless/settings.py:657
msgid "French" msgid "French"
msgstr "" msgstr ""
#: paperless/settings.py:656 #: paperless/settings.py:658
msgid "Hungarian" msgid "Hungarian"
msgstr "" msgstr ""
#: paperless/settings.py:657 #: paperless/settings.py:659
msgid "Italian" msgid "Italian"
msgstr "" msgstr ""
#: paperless/settings.py:658 #: paperless/settings.py:660
msgid "Japanese" msgid "Japanese"
msgstr "" msgstr ""
#: paperless/settings.py:659 #: paperless/settings.py:661
msgid "Luxembourgish" msgid "Luxembourgish"
msgstr "" msgstr ""
#: paperless/settings.py:660 #: paperless/settings.py:662
msgid "Norwegian" msgid "Norwegian"
msgstr "" msgstr ""
#: paperless/settings.py:661 #: paperless/settings.py:663
msgid "Dutch" msgid "Dutch"
msgstr "" msgstr ""
#: paperless/settings.py:662 #: paperless/settings.py:664
msgid "Polish" msgid "Polish"
msgstr "" msgstr ""
#: paperless/settings.py:663 #: paperless/settings.py:665
msgid "Portuguese (Brazil)" msgid "Portuguese (Brazil)"
msgstr "" msgstr ""
#: paperless/settings.py:664 #: paperless/settings.py:666
msgid "Portuguese" msgid "Portuguese"
msgstr "" msgstr ""
#: paperless/settings.py:665 #: paperless/settings.py:667
msgid "Romanian" msgid "Romanian"
msgstr "" msgstr ""
#: paperless/settings.py:666 #: paperless/settings.py:668
msgid "Russian" msgid "Russian"
msgstr "" msgstr ""
#: paperless/settings.py:667 #: paperless/settings.py:669
msgid "Slovak" msgid "Slovak"
msgstr "" msgstr ""
#: paperless/settings.py:668 #: paperless/settings.py:670
msgid "Slovenian" msgid "Slovenian"
msgstr "" msgstr ""
#: paperless/settings.py:669 #: paperless/settings.py:671
msgid "Serbian" msgid "Serbian"
msgstr "" msgstr ""
#: paperless/settings.py:670 #: paperless/settings.py:672
msgid "Swedish" msgid "Swedish"
msgstr "" msgstr ""
#: paperless/settings.py:671 #: paperless/settings.py:673
msgid "Turkish" msgid "Turkish"
msgstr "" msgstr ""
#: paperless/settings.py:672 #: paperless/settings.py:674
msgid "Ukrainian" msgid "Ukrainian"
msgstr "" msgstr ""
#: paperless/settings.py:673 #: paperless/settings.py:675
msgid "Chinese Simplified" msgid "Chinese Simplified"
msgstr "" msgstr ""

2
src/paperless/settings.py
View File

@ -437,6 +437,8 @@ SOCIALACCOUNT_PROVIDERS = json.loads(
os.getenv("PAPERLESS_SOCIALACCOUNT_PROVIDERS", "{}"), os.getenv("PAPERLESS_SOCIALACCOUNT_PROVIDERS", "{}"),
) )
DISABLE_REGULAR_LOGIN = __get_boolean("PAPERLESS_DISABLE_REGULAR_LOGIN")
AUTO_LOGIN_USERNAME = os.getenv("PAPERLESS_AUTO_LOGIN_USERNAME") AUTO_LOGIN_USERNAME = os.getenv("PAPERLESS_AUTO_LOGIN_USERNAME")
if AUTO_LOGIN_USERNAME: if AUTO_LOGIN_USERNAME: