mirrors/calibre-web
1
0
Fork 0
mirror of https://github.com/janeczku/calibre-web synced 2024-12-13 03:30:30 +00:00
Code Issues Releases Wiki Activity

Line endings

Ozzie Isaacs 2019-06-06 20:47:44 +02:00
parent 81be0d4225
commit 3f1f470f5e
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
FAQ.md

@ -18,12 +18,12 @@ All settings of Calibre-Web are stored in the app.db in the root folder of the p
### Which OPDS-Readers work with Calibre-Web?
I have succesfully tested the following OPDS-Reader:
- Chunky on iOS (mainly for comics)\
- Marvin and Marvin3 on iOS\
- Calibre-companion on Android (Book downloads viewing book details are also supported with this reader even it's not using the standard opds features)\
- Kybook 1/2/3 on iOS\
- Megareader on iOS (download seems not to work)\
- moon+ on Android (Cover pictures are only displayed with anonymous browsing enabled, tested with v4.5.7)\
- Chunky on iOS (mainly for comics)
- Marvin and Marvin3 on iOS
- Calibre-companion on Android (Book downloads viewing book details are also supported with this reader even it's not using the standard opds features)
- Kybook 1/2/3 on iOS
- Megareader on iOS (download seems not to work)
- moon+ on Android (Cover pictures are only displayed with anonymous browsing enabled, tested with v4.5.7)
- ebookdroid on Android (Download is only working with anonymous browsing enabled, tested with v2.6.3)
- Coolreader on Android (Cover pictures are not supported, tested with v3.2.29-1)
- FBReader on Android (Cover pictures are only displayed with anonymous browsing enabled, tested with v3.0.8)
@ -107,28 +107,28 @@ In a one user use case you can use the guest account for sending ebooks to kindl
### Error on Startup: "the STRING opcode argument must be quoted"
If the calibre-web repro is cloned via git and certain git setting are set (line endings conversion), this could cause this error. The cause is that the line endings in the file cps/translations/iso639.pickle are converted to "windows" endings. To solve the problem, please replace the file with the version from:\
https://raw.githubusercontent.com/janeczku/calibre-web/master/cps/translations/iso639.pickle\
`https://raw.githubusercontent.com/janeczku/calibre-web/master/cps/translations/iso639.pickle\`
or\
open the file with a advanced editor like notepad++ and change the line endings to Unix -> only LF\
open the file with a advanced editor like notepad++ and change the line endings to Unix -> only LF.
### Link Read Status to calibre custom column
In a single user Calibre installation you can use a boolean custom column to keep track of your read and unread books. Calobre-web can do the following. You can link the Calibre status to the read/unread status in Calibre-Web. As mentioned above this only works in a SINGLE USER use-case. If you are having more than one user in Calibre-Web this will cause trouble, because the read/unread status is than used for all users, so if one user ticks a book as read, all users will see this book as read. In a multiuser Calibre-Web use case it's aboslutly manatory not to use this feature.\
How to use the feature?\
1. Open Calibre (the Desktop program) and create a boolean custom column name it accordingly (e.g. Read Status)\
2. Calibre will ask you for a restart to apply the change. Afterewards please close Calibre\
3. For safety reasons it's recommended to restart Calibre-Web\
4. Log in to Calibre-Web as admin and go to Admin->UI configuration->View Configuration\
5. The field "Link read/unread status to Calibre column" should now offer a selection of all bolean custom columns of the corresponding Calibre library, select the appropriate entry and save\
In a single user Calibre installation you can use a boolean custom column to keep track of your read and unread books. Calobre-web can do the following. You can link the Calibre status to the read/unread status in Calibre-Web. As mentioned above this only works in a SINGLE USER use-case. If you are having more than one user in Calibre-Web this will cause trouble, because the read/unread status is than used for all users, so if one user ticks a book as read, all users will see this book as read. In a multiuser Calibre-Web use case it's absolutly manatory not to use this feature.\
How to use the feature?
1. Open Calibre (the Desktop program) and create a boolean custom column name it accordingly (e.g. Read Status)
2. Calibre will ask you for a restart to apply the change. Afterewards please close Calibre
3. For safety reasons it's recommended to restart Calibre-Web
4. Log in to Calibre-Web as admin and go to Admin->UI configuration->View Configuration
5. The field "Link read/unread status to Calibre column" should now offer a selection of all boolean custom columns of the corresponding Calibre library, select the appropriate entry and save
The read/unread status is now identical in Calibre and Calibre-Web
### How to handle Multiple calibre-libs
The recommended way for handling mulitple libraries is to start multiple instances of calibre-web. Instead of having several copies of the calibre-web code, command line options can be used for this. First start calibre-web with the normal command:\
`python3 [path to calibre-web]/cps.py`
Configure the path to the metadata.db, set the logfile to a new filename (e.g. instance1.log) and change the port to e.g. 8084. Now stop calibre-web rename the newly generated app.db to e.g. instance1.db. Repeat this procedure for every instance you want to run. At the end start all instance with the commandline-parameter -p:\
`python3 [path to calibre-web]/cps.py`\
Configure the path to the metadata.db, set the logfile to a new filename (e.g. instance1.log) and change the port to e.g. 8084. Now stop calibre-web rename the newly generated app.db to e.g. instance1.db. Repeat this procedure for every instance you want to run. At the end start all instance with the commandline-parameter -p:
```
nohup python3 [path to calibre-web]cps.py -p /[path to calibre-web]instance1.db
nohup python3 [path to calibre-web]cps.py -p /[path to calibre-web]instance2.db