paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove cruft

shamoon 2024-12-09 14:45:36 -08:00
parent d25c36a106
commit 0cb6550d55
1 changed files with 3 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
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=<redirect URI>`, `PAPERLESS_<Email Platform>_OAUTH_CLIENT_ID=<Client ID>` and `PAPERLESS_<Email Platform>_OAUTH_CLIENT_ID=<Client Secret>` 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 <Email Platform> 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