Man page - calibre-server(1)

Packages contains this manual

Available languages:

en fr mr pt_BR is es kn it ca pl vi nb sl lv pt eo ms ko fa eu et nl ar da cs gl tr zh_HK sk hu bg sv hr ja he lt uk fi ru ro zh_TW sr ka el zh_CN de

Manual

CALIBRE-SERVER

NAME
[рдкрд░реНрдпрд╛рдп]
AUTHOR
COPYRIGHT

NAME

calibre-server - calibre-server

calibre-server [options] [path to library folder...]

Start the calibre Content server. The calibre Content server exposes your calibre libraries over the internet. You can specify the path to the library folders as arguments to calibre-server . If you do not specify any paths, all the libraries that the main calibre program knows about will be used.

Whenever you pass arguments to calibre-server that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

[рдкрд░реНрдпрд╛рдп]

--access-log

Path to the access log file. This log contains information about clients connecting to the server and making requests. By default no access logging is done.

--ajax-timeout

Time (in seconds) to wait for a response from the server when making queries.

--auth-mode

рд╡рд╛рдкрд░рд▓реЗрд▓реЗ рдкреНрд░рдорд╛рдгреАрдХрд░рдгрд╛рдЪреЗ рдкреНрд░рдХрд╛рд░ рдирд┐рд╡рдбрд╛. Set the HTTP authentication mode used by the server. Set to " basic " if you are putting this server behind an SSL proxy. Otherwise, leave it as " auto " , which will use " basic " if SSL is configured otherwise it will use " digest " .

--auto-reload

Automatically reload server when source code changes. Useful for development. You should also specify a small value for the shutdown timeout.

--ban-after

Number of login failures for ban. The number of login failures after which an IP address is banned

--ban-for

Ban IP addresses that have repeated login failures. Temporarily bans access for IP addresses that have repeated login failures for the specified number of minutes. Useful to prevent attempts at guessing passwords. If set to zero, no banning is done.

--book-list-mode

рдкреБрд╕реНрддрдХрд╛рдВрдЪреНрдпрд╛ рдпрд╛рджреАрдЪреЗ рдбрд┐рдлреЙрд▓реНрдЯ рдореЛрдб рдирд┐рд╡рдбрд╛. Set the default book list mode that will be used for new users. Individual users can override the default in their own settings. The default is to use a cover grid.

--compress-min-size

Minimum size for which responses use data compression (in bytes).

--custom-list-template

Path to a JSON file containing a template for the custom book list mode. The easiest way to create such a template file is to go to Preferences-> Sharing over the net-> Book list template in calibre, create the template and export it.

--daemonize

рдкреНрд░рдХреНрд░рд┐рдпрд╛ рдкрд╛рд░реНрд╢реНрд╡рднреВрдореАрдд рдбреАрдорди рдореНрд╣рдгреВрди рдЪрд╛рд▓рд╡рд╛ (рдХреЗрд╡рд│ рд▓рд┐рдирдХреНрд╕рд╕рд╛рдареА).

--displayed-fields

Restrict displayed user-defined fields. Comma separated list of user-defined metadata fields that will be displayed by the Content server in the /opds and /mobile views. If you specify this option, any fields not in this list will not be displayed. For example: my_rating,my_tags

--enable-allow-socket-preallocation,
--disable-allow-socket-preallocation

Socket pre-allocation, for example, with systemd socket activation. рдбрд┐рдлреЙрд▓реНрдЯрдиреЗ рд╣рд╛ рдкрд░реНрдпрд╛рдп рд╕рдХреНрд░рд┐рдп рдЕрд╕рддреЛ.

--enable-auth, --disable-auth

Password based authentication to access the server. Normally, the server is unrestricted, allowing anyone to access it. You can restrict access to predefined users with this option. рдбрд┐рдлреЙрд▓реНрдЯрдиреЗ рд╣рд╛ рдкрд░реНрдпрд╛рдп рдирд┐рд╖реНрдХреНрд░рд┐рдп рдЕрд╕рддреЛ.

--enable-fallback-to-detected-interface,
--disable-fallback-to-detected-interface

Fallback to auto-detected interface. If for some reason the server is unable to bind to the interface specified in the listen_on option, then it will try to detect an interface that connects to the outside world and bind to that. рдбрд┐рдлреЙрд▓реНрдЯрдиреЗ рд╣рд╛ рдкрд░реНрдпрд╛рдп рд╕рдХреНрд░рд┐рдп рдЕрд╕рддреЛ.

--enable-local-write, --disable-local-write

Allow un-authenticated local connections to make changes. Normally, if you do not turn on authentication, the server operates in read-only mode, so as to not allow anonymous users to make changes to your calibre libraries. This option allows anybody connecting from the same computer as the server is running on to make changes. This is useful if you want to run the server without authentication but still use calibredb to make changes to your calibre libraries. Note that turning on this option means any program running on the computer can make changes to your calibre libraries. рдбрд┐рдлреЙрд▓реНрдЯрдиреЗ рд╣рд╛ рдкрд░реНрдпрд╛рдп рдирд┐рд╖реНрдХреНрд░рд┐рдп рдЕрд╕рддреЛ.

--enable-log-not-found, --disable-log-not-found

HTTP 404 (рд╕рд╛рдкрдбрд▓реЗ рдирд╛рд╣реА) рд╡рд┐рдирдВрддреНрдпрд╛рдВрдЪреА рдиреЛрдВрдж рдХрд░рд╛. Normally, the server logs all HTTP requests for resources that are not found. This can generate a lot of log spam, if your server is targeted by bots. Use this option to turn it off. рдбрд┐рдлреЙрд▓реНрдЯрдиреЗ рд╣рд╛ рдкрд░реНрдпрд╛рдп рд╕рдХреНрд░рд┐рдп рдЕрд╕рддреЛ.

--enable-use-bonjour, --disable-use-bonjour

BonJour рджреНрд╡рд╛рд░реЗ OPDS рдлреАрдбрд╛рдВрдЪреА рдЬрд╛рд╣рд┐рд░рд╛рдд рдХрд░рд╛. Advertise the OPDS feeds via the BonJour service, so that OPDS based reading apps can detect and connect to the server automatically. рдбрд┐рдлреЙрд▓реНрдЯрдиреЗ рд╣рд╛ рдкрд░реНрдпрд╛рдп рд╕рдХреНрд░рд┐рдп рдЕрд╕рддреЛ.

--enable-use-sendfile, --disable-use-sendfile

Zero copy file transfers for increased performance. This will use zero-copy in-kernel transfers when sending files over the network, increasing performance. However, it can cause corrupted file transfers on some broken filesystems. If you experience corrupted file transfers, turn it off. рдбрд┐рдлреЙрд▓реНрдЯрдиреЗ рд╣рд╛ рдкрд░реНрдпрд╛рдп рд╕рдХреНрд░рд┐рдп рдЕрд╕рддреЛ.

--help, -h

рд╣рд╛ рдорджрддреАрдЪрд╛ рдирд┐рд░реЛрдк рджрд╛рдЦрд╡реВрди рдмрд╛рд╣реЗрд░ рдкрдбрд╛

--ignored-fields

рдкреНрд░рдпреЛрдХреНрддреНрдпрд╛рдиреЗ рдирд┐рд╢реНрдЪрд┐рдд рдХреЗрд▓реЗрд▓реЗ рдореЗрдЯрд╛рдбреЗрдЯрд╛ рд░рдХрд╛рдиреЗ рджреБрд░реНрд▓рдХреНрд╖ рдХрд░рд╛. рд╕рд╛рдордЧреНрд░реАрдЪреНрдпрд╛ /opds рдЖрдгрд┐ /mobile рджреГрд╢реНрдпрд╛рдВрдордзреНрдпреЗ рди рджрд╛рдЦрд╡рд▓реЗ рдЬрд╛рдгрд╛рд░реНтАНрдпрд╛ рдкреНрд░рдпреЛрдХреНрддрд╛рдиреЗ рдирд┐рд╢реНрдЪрд┐рдд рдХреЗрд▓реЗрд▓реНрдпрд╛ рдореЗрдЯрд╛рдбреЗрдЯрд╛ рд░рдХрд╛рдиреНрдпрд╛рдВрдЪреА рд╕реНрд╡рд▓реНрдкрд╡рд┐рд░рд╛рдорд╛рдиреЗ рд╡рд┐рднрд╛рдЬрд┐рдд рдХреЗрд▓реЗрд▓реА рдпрд╛рджреА. рдЙрджрд╛рд╣рд░рдгрд╛рд░реНрде: my_rating,my_tags

--listen-on

The interface on which to listen for connections. The default is to listen on all available IPv6 and IPv4 interfaces. You can change this to, for example, " 127.0.0.1 " to only listen for IPv4 connections from the local machine, or to " 0.0.0.0 " to listen to all incoming IPv4 connections.

--log

Path to log file for server log. This log contains server information and errors, not access logs. By default it is written to stdout.

--manage-users

Manage the database of users allowed to connect to this server. You can use it in automated mode by adding a --. See calibre-server --manage-users -- help for details. See also the --userdb option.

--max-header-line-size

рдПрдХрд╛ HTTP рд╣реЗрдбрд░рдЪрд╛ рдХрдорд╛рд▓ рдЖрдХрд╛рд░ (рдХрд┐.рдмрд╛.).

--max-job-time

рдХрд╛рдордЧрд╛рд░ рдкреНрд░рдХреНрд░рд┐рдпрд╛рдВрд╕рд╛рдареАрдЪрд╛ рдХрдорд╛рд▓ рд╡реЗрд│. Maximum amount of time worker processes are allowed to run (in minutes). Set to zero for no limit.

--max-jobs

рдХрд╛рдордЧрд╛рд░ рдкреНрд░рдХреНрд░рд┐рдпрд╛рдВрдЪреА рдХрдорд╛рд▓ рд╕рдВрдЦреНрдпрд╛. Worker processes are launched as needed and used for large jobs such as preparing a book for viewing, adding books, converting, etc. Normally, the max. number of such processes is based on the number of CPU cores. You can control it by this setting.

--max-log-size

рдХрдорд╛рд▓ рдиреЛрдВрджрд╡рд╣реА рдлрд╛рдИрд▓рдЪрд╛ рдЖрдХрд╛рд░ (рдореЗ.рдмрд╛.). The maximum size of log files, generated by the server. When the log becomes larger than this size, it is automatically rotated. Set to zero to disable log rotation.

--max-opds-items

OPDS рдлреАрдбрд╛рдВрдордзреАрд▓ рдкреБрд╕реНрддрдХрд╛рдВрдЪреА рдХрдорд╛рд▓ рд╕рдВрдЦреНрдпрд╛. The maximum number of books that the server will return in a single OPDS acquisition feed.

--max-opds-ungrouped-items

Maximum number of ungrouped items in OPDS feeds. Group items in categories such as author/tags by first letter when there are more than this number of items. Set to zero to disable.

--max-request-body-size

Max. allowed size for files uploaded to the server (in MB).

--num-per-page

рдПрдХрд╛ рдкрд╛рдирд╛рдд рджрд╛рдЦрд╡рд╛рдпрдЪреНрдпрд╛ рдкреБрд╕реНрддрдХрд╛рдВрдЪреА рд╕рдВрдЦреНрдпрд╛. рдмреНрд░рд╛рдЙрдЭрд░рдордзреНрдпреЗ рдПрдХрд╛ рдкрд╛рдирд╛рд╡рд░ рджрд╛рдЦрд╡рд╛рдпрдЪреНрдпрд╛ рдкреБрд╕реНрддрдХрд╛рдВрдЪреА рд╕рдВрдЦреНрдпрд╛.

--pidfile

Write process PID to the specified file

--port

The port on which to listen for connections.

--search-the-net-urls

Path to a JSON file containing URLs for the " Search the internet " feature. The easiest way to create such a file is to go to Preferences-> Sharing over the net->Search the internet in calibre, create the URLs and export them.

--shutdown-timeout

Total time in seconds to wait for clean shutdown.

--ssl-certfile

SSL рдкреНрд░рдорд╛рдгрдкрддреНрд░ рдлрд╛рдпрд▓реАрдЪрд╛ рдкрд╛рде.

--ssl-keyfile

Path to the SSL private key file.

--timeout

Time (in seconds) after which an idle connection is closed.

--trusted-ips

Allow un-authenticated connections from specific IP addresses to make changes. Normally, if you do not turn on authentication, the server operates in read-only mode, so as to not allow anonymous users to make changes to your calibre libraries. This option allows anybody connecting from the specified IP addresses to make changes. Must be a comma separated list of address or network specifications. This is useful if you want to run the server without authentication but still use calibredb to make changes to your calibre libraries. Note that turning on this option means anyone connecting from the specified IP addresses can make changes to your calibre libraries.

--url-prefix

A prefix to prepend to all URLs. Useful if you wish to run this server behind a reverse proxy. For example use, /calibre as the URL prefix.

--userdb

Path to the user database to use for authentication. The database is a SQLite file. To create it use --manage-users . You can read more about managing users at: - https://manual.calibre-ebook.com/server.html#managing-user-accounts-from-the-command-line-only

--version

рдкреНрд░реЛрдЧреНрд░рд╛рдордЪреНрдпрд╛ рдЖрд╡реГрддреНрддреАрдЪреА рд╕рдВрдЦреНрдпрд╛ рджрд╛рдЦрд╡рд╛ рдЖрдгрд┐ рдордЧ рдмрд╛рд╣реЗрд░ рдкрдбрд╛

--worker-count

Number of worker threads used to process requests.

AUTHOR

Kovid Goyal

COPYRIGHT

Kovid Goyal