Added some header formatting + added section on use of magic link

Northguy 2021-11-15 12:34:21 +01:00
parent 8af1ddd7d6
commit 4516d67dcb
1 changed files with 24 additions and 17 deletions

@ -3,11 +3,11 @@
The configuration can be changed as admin in the admin panel under "Basic Configuration" and "UI Configuration"
## Basic Configuration:
Location of Calibre database:\
**Location of Calibre database:**\
The location of a valid metadata.db file as created by the Calibre program. The File has to be on a mounted drive of the server running calibre-Web (for setup with Google Drive please take a look in the corresponding chapter). You only enter the path, no special care has to be taken about spaces or Non-ASCII characters. The must not be included in apostrophes. "/" or "\" work as seperators. The name metadata.db is not allowed as part of the path.
Example: /folder with space
Server Port:\
**Server Port:**\
Changes the port Calibre-Web is listening, changes take effect after pressing submit button. To reach the Calibre-Web instance afterwards you have to change the port manually in your browser
### (Optional) SSL Configuration
@ -28,41 +28,48 @@ You can set the loglevel of the integrated logfiles. Default is INFO, which is r
You can specifiy a different name and different location for the logfile. logfile.log creates a logfile with this name in the Calibre-Web folder, where c:\bücher\log.log creates a logfile with the name log.log in the "bücher" folder on drive "c:". Please make sure Calibre-Web has write access to the folder you specify.
On linux you can use "/dev/stderr" to log to standard-error or "/dev/stdout" to log to the standard output.
### Feature Configuration
## Feature Configuration
Enable public registration:\
### Enable public registration:
Tick to enable public user registration. Users can then register with the Calibre-Web instance on their own with a valid email adress. In the SMTP Server section valid domains for registrations can be limited.
If the additional setting "Use E-Mail as Username" is set, users can not choose their own username, the e-mail address is taken as username.
Prerequisites: The SMTP Server setup has to be completed.
Enable anonymous browsing:\
### Enable anonymous browsing:
Tick to allow not logged in users to browse the catalog, anonymous user permissions can be set as admin ("Guest" user)
Enable Uploading:\
### Enable Uploading:
Tick to enable uploading of PDF, epub, FB2, TXT, Mobi, AZW, AZW3, HTML, RTF, ODT, DJVU, PRC, DOC, DOCX, MP3, M4A, M4B, CBR, CBZ, and CBT files. If imagemagick library is installed, covers can be extracted from some (PDF, epub, CBT, CBZ) of the uploaded file formats. With installed rarfile covers from cbr files can be exctracted also. If a language viewing restriction is applied while uploading the book, book language is automatically set to this language to allow the user to view the recently uploaded book. Books can also be uploaded using drag and drop. Just drag your files to the main area of calibre-web, the shelf order page is excludes, all other pages work. Uploading more than one file at a time is also possible.
Enable remote login ("magic link"):\
### Enable remote login ("magic link"):
Tick to enable remote login, i.e. a link that allows user to log in via a different device.
The remote login feature was made for devices where it is hard to enter a lot of text, like on ebook readers. After enabeling this feature you see the magic link link on the login page:
![](https://user-images.githubusercontent.com/6438895/60754029-99e3ad00-9fdb-11e9-8d70-3bbebedc3518.png)
On your ebook reader (or any other device you want to get logged in) you click on magic link. Afterwards you log in on you desktop computer with the account you want to get logged in on the reader and afterwards you enter the generated magic link (visible on your ebook reader) in the desktop computer. Magically after one or two seconds you are logged in on the ebook reader, too.
### External binaries
You can choose to use calibre's ebook converter to convert ebooks from one format to another. Please choose the corresponding option. In path to convertertool the path and name of the file ebook-converter (part of calibre) has to be entered. (On Linux usualy /opt/calibre/ebook-convert, for windows it's usually c:\program files\calibre\ebook-convert.exe). Calibre offers a lot of options to modify the behavior of the ebook-converter, the options can be entered in the E-Book converter settings.\
## UI Configuration:
Title:\
**Title:**\
The title of the instance of Calibre-Web can be changed (usefull if you are having more than on instance running). The name is shown in the upper left corner of the webpage.
Books per page:\
**Books per page:**\
Limits the number of book covers shown on one page (and the number of books loading during the infinite scrolling mode). To prevent the infinite scrolling mode set the "Books per page" to a number displayed on one page in your browser. In this case you will see pagination informations on the bootom of the page (only valid for the Standard Theme)
No. of random books:\
**No. of random books:**\
Limits the number of books showning up in the random books section. To deactivate the feature untick the "Show random books in detail view" on the user's settings page.
No. of Authors to Display before hiding:\
**No. of Authors to Display before hiding:**\
If books having many authors, cover view pages can be very confusing. Therefore it's possible to limit the number of authors shown in this case. Entering a zero deactivates this feature and all authors are shown.
Theme:\
**Theme:**\
Currently Calibre-Web supports two theme, the Standard ligh one, and the dark Caliblur! plex like theme.
Regular expression for ignoring columns and Link read/unread status to Calibre column:\
@ -70,10 +77,10 @@ If you having a bool custom column in Calibre you can use it as a "global" read/
Example: `.\*` would exclude all custom columns, `Read` only the column with the name column, `^My\scol.\*` all Columns starting with `My col`.
The filtering is based on the columns name (headline in german Calibre) and not the column lookup
Regular expression for title sorting:\
**Regular expression for title sorting:**\
Calibre stores internally the title and a "sorted title". Title often starting with articles like "A" in english, or "Die/Der/Das" in german, which make no sense to sort after, therfore all of the listed words in these field are ignored for sorting the title. The default is taken from a german Calibre program. For french it should be something like "^(Le|La)\s"
Link Read/Unread Status to Calibre Column:\
**Link Read/Unread Status to Calibre Column:**\
In a single user Calibre installation you can use a boolean custom column to keep track of your read and unread books. Calibre-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 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)
@ -83,7 +90,7 @@ How to use the feature?
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
Visibility Restrictions based on Calibre Custom Column:\
**Visibility Restrictions based on Calibre Custom Column:**\
You can add restrictions based on Custom Columns if you want to hide certain books from some users (like your kids). In this setting you define the Custom Column where the restriction shall be based on. If you see None as only option, you have no text content Custom Columns in your Calibre Lib.
The restrictions are on per user base, to change the restrictions of exisiting users, goto `edit user` and than you can edit the restrictions for this specific user.
@ -93,10 +100,10 @@ The restrictions are on per user base, to change the restrictions of exisiting u
The options selected in this section define the access rights and visibilitys new users having upon registering, and the default settings for newly created users by the admin (can be changed during initial creation, or later by admins).
The visibilitys (except Visibility Restriction settings) can be changed by the users themselves later on. The Guest user (User for anonymous access) is an except from this, only admins can change the visibilities for the Guest user.
Visibility Restrictions based on Calibre Custom Column:\
**Visibility Restrictions based on Calibre Custom Column:**\
You can allow and deny the visibility of books based on the content of the Custom Colum selected by `View Restriction based on Calibre Custom Column` setting. You can define a default Visibilitys in the `Default Visibilitys for New Users` section. Admins can change their own visibility restrictions on their own user settings page. You can restrict the visibility to only certain entries in this column (like user is only allowed to view books with entry "Kids") by allowing this Column entry, or exclude certain entries (like user is not allowed to view books with entry "Adult"). Allowing and dening content based on Custom Columns can be combined and can also be combined with restricts based on tags.
Visibility Restrictions based on Tags:\
**Visibility Restrictions based on Tags:**\
You can allow and deny the visibility of books based on `tags`. You can define a default Visibilitys based on tags in the `Default Visibilitys for New Users` section. Admins can change their own visibility restrictions on their own user settings page. You can restrict the visibility to only certain tags (like user is only allowed to view books tagged as "kid") by allowing this tag, or exclude books with certain tags (like user is not allowed to view books with tag "Adult"). Allowing and dening content based on Custom Columns can be combined and can also be combined with restricts based on tags.
### eBook Viewer and eBook Download