From 608bbfae6027fb233a2b1c71cc3bc0495082fb0e Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 7 Oct 2024 12:06:38 -0700 Subject: [PATCH] Fix some docs stuff --- docs/configuration.md | 8 ++++---- docs/usage.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 4298de6ac..5fa4ab0a7 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1219,25 +1219,25 @@ consumers working on the same file. Configure this to prevent that. #### [`PAPERLESS_GMAIL_OAUTH_CLIENT_ID=`](#PAPERLESS_GMAIL_OAUTH_CLIENT_ID) {#PAPERLESS_GMAIL_OAUTH_CLIENT_ID} -: The OAuth client ID for Gmail. This is required for Gmail OAuth Email setup. See [Gmail OAuth Email Setup](usage.md#oauth-email-setup) for more information. +: The OAuth client ID for Gmail. This is required for Gmail OAuth Email setup. See [OAuth Email Setup](usage.md#oauth-email-setup) for more information. Defaults to none. #### [`PAPERLESS_GMAIL_OAUTH_CLIENT_SECRET=`](#PAPERLESS_GMAIL_OAUTH_CLIENT_SECRET) {#PAPERLESS_GMAIL_OAUTH_CLIENT_SECRET} -: The OAuth client secret for Gmail. This is required for Gmail OAuth Email setup. See [Gmail OAuth Email Setup](usage.md#oauth-email-setup) for more information. +: The OAuth client secret for Gmail. This is required for Gmail OAuth Email setup. See [OAuth Email Setup](usage.md#oauth-email-setup) for more information. Defaults to none. #### [`PAPERLESS_OUTLOOK_OAUTH_CLIENT_ID=`](#PAPERLESS_OUTLOOK_OAUTH_CLIENT_ID) {#PAPERLESS_OUTLOOK_OAUTH_CLIENT_ID} -: The OAuth client ID for Outlook. This is required for Outlook OAuth Email setup. See [Outlook OAuth Email Setup](usage.md#oauth-email-setup) for more information. +: The OAuth client ID for Outlook. This is required for Outlook OAuth Email setup. See [OAuth Email Setup](usage.md#oauth-email-setup) for more information. Defaults to none. #### [`PAPERLESS_OUTLOOK_OAUTH_CLIENT_SECRET=`](#PAPERLESS_OUTLOOK_OAUTH_CLIENT_SECRET) {#PAPERLESS_OUTLOOK_OAUTH_CLIENT_SECRET} -: The OAuth client secret for Outlook. This is required for Outlook OAuth Email setup. See [Outlook OAuth Email Setup](usage.md#oauth-email-setup) for more information. +: The OAuth client secret for Outlook. This is required for Outlook OAuth Email setup. See [OAuth Email Setup](usage.md#oauth-email-setup) for more information. Defaults to none. diff --git a/docs/usage.md b/docs/usage.md index e582adbc3..e3b3420ea 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -202,11 +202,11 @@ configured via [`PAPERLESS_EMAIL_TASK_CRON`](configuration.md#PAPERLESS_EMAIL_TA #### OAuth Email Setup -Paperless-ngx supports OAuth2 for email accounts. This is currently supported for Gmail and Outlook accounts. To set up an email account with OAuth2, you will need to create an app in the respective service and obtain the [client ID and client secret](configuration.md#email_oauth). You will also need to set either the [callback base url](configuration.md#PAPERLESS_OAUTH_CALLBACK_BASE_URL) or (`PAPERLESS_URL`)[configuration.md#PAPERLESS_URL] to the correct value for the OAuth flow to work correctly. +Paperless-ngx supports OAuth2 authentication for Gmail and Outlook email accounts. To set up an email account with OAuth2, you will need to create an app with the respective provider and obtain the client ID and client secret and set the appropriate [configuration variables](configuration.md#email_oauth). You will also need to set either [`PAPERLESS_OAUTH_CALLBACK_BASE_URL`](configuration.md#PAPERLESS_OAUTH_CALLBACK_BASE_URL) or [`PAPERLESS_URL`](configuration.md#PAPERLESS_URL) to the correct value for the OAuth2 flow to work correctly. -Specific instructions for setting up the required app in Gmail and Outlook are beyond the scope of this document, but you can find user-maintained instructions on [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Email-OAuth-App-Setup) or by searching the web. +Specific instructions for setting up the required app in Gmail and Outlook are beyond the scope of this documentation, but you can find user-maintained instructions in [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Email-OAuth-App-Setup) or by searching the web. -Once setup, navigating to the email settings page in the Paperless-ngx UI will allow you to add an email account for Gmail or Outlook using the OAuth2 method. After authenticating with the OAuth flow you will be presented with the newly created account where you will need to enter your email address. After this, the account will work as any other email account in Paperless-ngx and refreshing tokens will be handled automatically. +Once setup, navigating to the email settings page in Paperless-ngx will allow you to add an email account for Gmail or Outlook using OAuth2. After authenticating, you will be presented with the newly-created account where you will need to enter and save your email address. After this, the account will work as any other email account in Paperless-ngx and refreshing tokens will be handled automatically. ### REST API