diff --git a/Configuration.md b/Configuration.md index 5f313ba..5a8a746 100644 --- a/Configuration.md +++ b/Configuration.md @@ -58,60 +58,80 @@ Calibre Calibre library (metadata.db) can be located on a Google Drive. Addition To use google drive integration, you have to use the google developer console to create a new app. https://console.developers.google.com. 1. After login create a project: + ![Dashboard](images/gdrive/dashboard.png) 2. Choose a name and save the project: + ![Create project](images/gdrive/create_project.png) 3. Activate the API for the created project by clicking on enable APIs and services or API library + ![Activate API](images/gdrive/activate_api.png) 4. Choose Google Drive API from the listed Apps + ![API Library](images/gdrive/library.png) 5. Enable the Google Drive API by clicking on enable + ![Enable Gdrive](images/gdrive/gdrive_enable.png) -6. Create credentials for the API -![API enabled Dashboard](images/gdrive/api_enabled_dashboard.png) +6. Click on Configure consent screen: -7. Click on create credentials in the following screen: -![API enabled Dashboard](images/gdrive/create_credentials.png) - -8. First you need to enter a domain (this is the adress, if you want to access your server from the internet) for the gdrive callbacks: -![Domain verification](images/gdrive/verify_domain.png) - -9. Optional:If you want to use the "watch metadata.db function" you have to verify your domain with google. In this case, please press the search console link first, finish this procedure and enter the domain in this popup afterwards and save - -9. Otherwise please enter your domain name and click on enter -![Domain verification](images/gdrive/domain_verify_screen.png) - -10. Go to the Credentials tab and choose OAuth Client ID -![credentials](images/gdrive/credentials.png) - -11. Click on Configure consent screen: ![Configure Consent screen](images/gdrive/consent_screen.png) -12. Enter\ +8. Enter\ your e-mail adress,\ the applications name,\ -the domain you entered in the verify domain section\ +the domain name of your application \ and add scope for '../auth/drive': + ![Setup Credentials](images/gdrive/setup_credentials_oauth.png) -13. Choose the app type: Web-application, enter in the field 'Authorized redirect URIs' the complete domain adress with the callback path: CALIBRE_WEB_URL/gdrive/callback\ +Save your changes. + +8. Click on create credentials in the following screen: + +Choose OAuth Client ID from the selection. + +![API enabled Dashboard](images/gdrive/create_credentials.png) + +9. Choose the app type: Web-application, enter in the field 'Authorized redirect URIs' the complete domain adress with the callback path: CALIBRE_WEB_URL/gdrive/callback\ E.g.: For a https connection to example.com where Calibre-Web is located in the folder 'test' you have to enter: https://example.com/test/gdrive/callback The address has to be public, localhost, http://internalServername or similar wont work. The field can't be empty. + ![Web application](images/gdrive/web_app.png) -14. Google is now presenting your client ID and your client secret. We just close the popup, we download the informations. +10. Google is now presenting your client ID and your client secret. We just close the popup, we download the informations. + ![Setup Finished](images/gdrive/setup_finished.png) -15. Now we download the informations in json format by clicking on the download button on the overview page +11. Now we download the informations in json format by clicking on the download button on the overview page + ![Download credentials](images/gdrive/finished_overview.png) -16. Download json file and place it in `calibre-web` directory, with the name `client_secrets.json` +12. Download json file and place it in `calibre-web` directory, with the name `client_secrets.json` + +13. Final step is the verification of your domain. + +![Download credentials](images/gdrive/domain_verification_start.png) + +14. First you need to add your domain (this is the adress, if you want to access your server from the internet) to the **google search console**: + +![Domain verification](images/gdrive/verify_domain.png) + +15. Please follow the steps there for verifiying the domain address + +The one one the right is the easiest for self hosted domains. +After entering your domain name, download the html file and make it accessible under the address http[s]://[your-domain-name]/[filename] + +16. Afterwards you can enter your domain to the screen from step 14 and activate your domain + +![Domain verification](images/gdrive/domain_verified.png) + + The Drive API should now be setup and ready to use, so we need to integrate it into Calibre-Web. This is done as described below:\ diff --git a/images/gdrive/api_enabled_dashboard.png b/images/gdrive/api_enabled_dashboard.png deleted file mode 100644 index 8acf052..0000000 Binary files a/images/gdrive/api_enabled_dashboard.png and /dev/null differ diff --git a/images/gdrive/consent_screen.png b/images/gdrive/consent_screen.png index b92b6d9..1d66361 100644 Binary files a/images/gdrive/consent_screen.png and b/images/gdrive/consent_screen.png differ diff --git a/images/gdrive/create_credentials.png b/images/gdrive/create_credentials.png index dec3888..323ab6e 100644 Binary files a/images/gdrive/create_credentials.png and b/images/gdrive/create_credentials.png differ diff --git a/images/gdrive/credentials.png b/images/gdrive/credentials.png deleted file mode 100644 index f063758..0000000 Binary files a/images/gdrive/credentials.png and /dev/null differ diff --git a/images/gdrive/dashboard.png b/images/gdrive/dashboard.png index 59b808a..fe671a2 100644 Binary files a/images/gdrive/dashboard.png and b/images/gdrive/dashboard.png differ diff --git a/images/gdrive/domain_verification_start.png b/images/gdrive/domain_verification_start.png new file mode 100644 index 0000000..4d8de69 Binary files /dev/null and b/images/gdrive/domain_verification_start.png differ diff --git a/images/gdrive/domain_verified.png b/images/gdrive/domain_verified.png new file mode 100644 index 0000000..eb1e0c4 Binary files /dev/null and b/images/gdrive/domain_verified.png differ diff --git a/images/gdrive/domain_verify_screen.png b/images/gdrive/domain_verify_screen.png deleted file mode 100644 index e6debaa..0000000 Binary files a/images/gdrive/domain_verify_screen.png and /dev/null differ diff --git a/images/gdrive/setup_credentials_oauth.png b/images/gdrive/setup_credentials_oauth.png index 2ab8ab7..b5c6196 100644 Binary files a/images/gdrive/setup_credentials_oauth.png and b/images/gdrive/setup_credentials_oauth.png differ diff --git a/images/gdrive/verify_domain.png b/images/gdrive/verify_domain.png index 342bf60..e6debaa 100644 Binary files a/images/gdrive/verify_domain.png and b/images/gdrive/verify_domain.png differ