Scroll to navigation

CALIBRE-SERVER(1) calibre CALIBRE-SERVER(1)

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"

[OPTIES]

--access-log
Pad naar toegangslogbestand. Dit houdt informatie bij over clients die verbinding maken met de server en aanvragen indienen. Standaard worden geen toegangslogbestanden bijgehouden.

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

--auth-mode
Kies het type authenticatie dat gebruikt is. 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
Herstart automatisch wanneer de bron code veranderd. Handig voor ontwikkeling. U zou ook een kleine waarde moeten geven aan de afsluit 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
Choose the default 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
Run process in background as a daemon (Linux only).

--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. By default, this option is enabled.

--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. By default, this option is disabled.

--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. By default, this option is enabled.

--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. By default, this option is disabled.

--enable-log-not-found, --disable-log-not-found
Log HTTP 404 (Not Found) requests. 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. By default, this option is enabled.

--enable-use-bonjour, --disable-use-bonjour
Adverteer OPDS feeds via BonJour. Advertise the OPDS feeds via the BonJour service, so that OPDS based reading apps can detect and connect to the server automatically. By default, this option is enabled.

--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. By default, this option is enabled.

--help, -h
toon dit helpbericht en stop

--ignored-fields
Genegeerde door de gebruiker gedefinieerde metagegevensvelden. Door komma's gescheiden lijst van door de gebruiker gedefinieerde metagegevens gegevensvelden die niet door de inhoudsserver in de weergaven /OPDS en /mobiel worden weergegeven. Bijvoorbeeld: my_rating,my_tags

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

--log
Pad naar logbestand voor serverlog. Dit logbestand bevat servergegevens en fouten, maar geen toegangslogs. Het wordt standaard naar stdout geschreven.

--manage-users
Beheer de gegevensbank van gebruikers die met deze server een verbinding mogen maken. Raadpleeg ook de optie --userdb.

--max-header-line-size
Max. grootte van enkele HTTP header (in KB).

--max-job-time
Maximale tijd voor werkprocessen. Maximum amount of time worker processes are allowed to run (in minutes). Set to zero for no limit.

--max-jobs
Maximale aantal werkprocessen. 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
Max. logfile grootte (in MB). 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
Maximale aantal boeken in OPDS feeds. The maximum number of books that the server will return in a single OPDS acquisition feed.

--max-opds-ungrouped-items
Maximaal aantal niet-gegroepeerde items in OPDS-feeds. Groepeer items in categorieën zoals auteur/labels per beginletter wanneer er meer items dan dit aantal zijn. Stel op nul in om uit te schakelen.

--max-request-body-size
Toegestane max. bestandsgrootte om naar server te uploaden (in MB).

--num-per-page
Number of books to show in a single page. The number of books to show in a single page in the browser.

--pidfile
Schrijf het PID van het proces naar het opgegeven bestand

--port
De poort waarop geluisterd word naar verbindingen.

--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
Totaaltijd in seconden om te wachten om netjes af te sluiten.

--ssl-certfile
Pad naar bestand SSL certificaat.

--ssl-keyfile
Pad naar bestand SSL persoonlijke sleutel.

--timeout
Tijd (in seconden) totdat een inactieve verbinding wordt gesloten.

--url-prefix
Een prefix om voor alle URL's te zetten. 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/nl/server.html#managing-user-accounts-from-the-command-line-only

--version
toon programmaversie en stop

--worker-count
Number of worker threads used to process requests.

AUTHOR

Kovid Goyal

COPYRIGHT

Kovid Goyal
September 13, 2019 3.48.0