mirrors
/
calibre-web
mirror of https://github.com/janeczku/calibre-web
1
0
Fork 0
Code Issues Releases Wiki Activity

Typos and file location update for pip installation

Ozzie Isaacs 2022-02-03 21:14:21 +01:00
parent 25653f93d0
commit 9ace5f6c71
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
G-Drive-Setup.md

@ -1,6 +1,6 @@
# Using Google Drive integration
Calibre Calibre library (metadata.db) can be located on a Google Drive. Additional optional dependencys are necessary to get this work. Please install all optional requirements by executing `pip install --target vendor -r optional-requirements.txt`
Calibre library (metadata.db) can be located on a Google Drive. Additional optional dependencies are necessary to get this work. Depending on your type of installation install the dependencies via `pip install calibreweb[gdrive]` or for the manual installation install the dependencies by executing `pip install --target vendor -r optional-requirements.txt`
To use Google Drive integration, you have to use the Google Developer Console to create a new app. https://console.developers.google.com.
@ -44,32 +44,32 @@ 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\
9. Choose the app type: Web-application, enter in the field 'Authorized redirect URIs' the complete domain address 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)
10. 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 information.
![Setup Finished](images/gdrive/setup_finished.png)
11. Now we download the informations in json format by clicking on the download button on the overview page
11. Now we download the information in json format by clicking on the download button on the overview page
![Download credentials](images/gdrive/finished_overview.png)
12. 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`. For manual installation place the file with the same name into the `calibre-web` directory.
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**:
14. First you need to add your domain (this is the address, 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
15. Please follow the steps there for verifying 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]
@ -82,8 +82,8 @@ After entering your domain name, download the html file and make it accessible u
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:\
1. Open config page (happens automatically during inital config, otherwise open "Edit Calibre Database Configuration" in admin section)
2. Enter the location that will be used to store the metadata.db file locally, and to temporary store uploaded books and other temporary files for upload ("Location of Calibre database"). The metadata.db file has to exist and should be consitent with the books stored on Google Drive.
1. Open config page (happens automatically during initial config, otherwise open "Edit Calibre Database Configuration" in admin section)
2. Enter the location that will be used to store the metadata.db file locally, and to temporary store uploaded books and other temporary files for upload ("Location of Calibre database"). The metadata.db file has to exist and should be consistent with the books stored on Google Drive.
3. Tick Use Google Drive\
![Inital config](images/gdrive/inital_config.png)
@ -97,15 +97,15 @@ The Drive API should now be setup and ready to use, so we need to integrate it i
![Allow authenticate](images/gdrive/google_allow.png)
7. Select the folder that is the root of your calibre library on Gdrive ("Google drive Calibre folder")
7. Select the folder that is the root of your Calibre library on Gdrive ("Google drive Calibre folder")
![Select Google Drive folder](images/gdrive/google_return.png)
8. Click the "Save" button
9. Google Drive should now be connected and be used to get images and download Epubs. The metadata.db is stored in the calibre library location. Upon Upload of new books the calibre library folder acts as temporary folder before the final upload to Google Drive.
9. Google Drive should now be connected and be used to get images and download Epubs. The metadata.db is stored in the Calibre library location. Upon Upload of new books the Calibre library folder acts as temporary folder before the final upload to Google Drive.
# Google Drive Optional configuration
If your Calibre-Web is using https, it is possible to add a "watch" to the drive. This will inform us if the metadata.db file is updated from outside and allows us to update our calibre library accordingly.
Additionally the public adress your server uses (e.g.https://example.com) has to be verified in the Google developer console. After this is done, please wait a few minutes, then
If your Calibre-Web is using https, it is possible to add a "watch" to the drive. This will inform us if the metadata.db file is updated from outside and allows us to update our Calibre library accordingly.
Additionally the public address your server uses (e.g.https://example.com) has to be verified in the Google developer console. After this is done, please wait a few minutes, then
10. Open "Edit Calibre Database Configuration" page
11. Click enable watch of metadata.db