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

Updated Email OAuth App Setup (markdown)

PolyKelvin 2024-12-06 11:19:31 +08:00
parent b9389037db
commit 2c643faa22
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Email-OAuth-App-Setup.md

@ -6,13 +6,24 @@ In both cases you will need to specify your Paperless-ngx installation's Redirec
1. Login to the Google Cloud Console and create a Project.
2. In the Cloud Console, navigate to the “APIs & Services” > “Library” section and enable Gmail API
2. In the Cloud Console, navigate to the **“APIs & Services”** > **“Library”** section and enable **Gmail API**
3. In the Cloud Console, navigate to the “APIs & Services” > “OAuth Consent Screen” section and create a screen. Make no changes to the "Scopes" page.
3. In the Cloud Console, navigate to the **“APIs & Services”** > **“OAuth Consent Screen”** section and create a screen. Make no changes to the "Scopes" page.
4. Under "Credentials" create a new "OAuth client ID", choose a web application and set the authorized javascript origins and redirect URI
4. Under **"Credentials"** create a new **"OAuth client ID"**, choose a web application and set the **authorized javascript origins** and **redirect URI**
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 :)
5. Obtain Client ID and Client Secret
### Outlook