diff --git a/Email-OAuth-App-Setup.md b/Email-OAuth-App-Setup.md index f2d8777..de1b6a3 100644 --- a/Email-OAuth-App-Setup.md +++ b/Email-OAuth-App-Setup.md @@ -1,8 +1,9 @@ > ⚠️ _Note: these instructions are user-maintained_ -In both cases you will need to specify your Paperless-ngx installation's Redirect URI as e.g. 'https://paperless.example.com/api/oauth/callback/' +See the [Paperless-ngx documentation](https://docs.paperless-ngx.com/usage/#oauth-email-setup) about setting up OAuth. In both cases you will need to specify your Paperless-ngx installation's Redirect URI as e.g. `https://paperless.example.com/api/oauth/callback/`. ### Gmail +See https://support.google.com/cloud/answer/6158849 1. Login to the Google Cloud Console and create a Project. @@ -14,16 +15,7 @@ In both cases you will need to specify your Paperless-ngx installation's Redirec 5. Obtain Client ID and Client Secret. Simply copy it in your created "OAuth 2.0 Client IDs" in "Credentials" (Or download the `.json` files) -6. If you run paperless on docker,`PAPERLESS_OAUTH_CALLBACK_BASE_URL=`, `PAPERLESS__OAUTH_CLIENT_ID=` and `PAPERLESS__OAUTH_CLIENT_ID=` in docker.env. Remember to save and restart the container(s). - - a. If you are using google personal, you need to add the the user account (the gmail account you want to use) into **"Test users"** in **"OAuth consent screen"** - -7. If you doing this correctly, after restart you will see a `Connect Account` button, click and follow the instruction of the corresponding platform. - -8. After finish, add the account in Pperless-ngx WebGUI, it should automcatilly open a panel allow you to input the username, all other credentials should already been done. Simply save the email account. Check the IMAP Server, IMAP Port should be `imap.gmail.com` and `993` (Subject to change base on Google ICMP policy) - -9. Congrats :) - +6. Set the appropriate [config variables](https://docs.paperless-ngx.com/configuration/#email_oauth). ### Outlook