calibre-server

calibre-server [options]

Start the calibre content server. The calibre content server exposes your calibre library over the internet. The default interface allows you to browse you calibre library by categories. You can also access an interface optimized for mobile browsers at /mobile and an OPDS based interface for use with reading applications at /opds.

The OPDS interface is advertised via BonJour automatically.

Whenever you pass arguments to calibre-server that have spaces in them, enclose the arguments in quotation marks.

[options]

--auto-reload

Auto reload server when source code changes. May not work in all environments.

--daemonize

Run process in background as a daemon. No effect on windows.

--develop

Development mode. Server automatically restarts on file changes and serves code files (html, css, js) from the file system instead of calibre’s resource system.

--help, -h

show this help message and exit

--max-cover

The maximum size for displayed covers. Default is ‘600x800’.

--max-opds-items

The maximum number of matches to return per OPDS query. This affects Stanza, WordPlayer, etc. integration.

--max-opds-ungrouped-items

Group items in categories such as author/tags by first letter when there are more than this number of items. Default: 100. Set to a large number to disable grouping.

--password

Set a password to restrict access. By default access is unrestricted.

--pidfile

Write process PID to the specified file

--port, -p

The port on which to listen. Default is 8080

--restriction

Specifies a virtual library to be used for this invocation. This option overrides any per-library settings specified in the GUI. For compatibility, if the value is not a virtual library but is a saved search, that saved search is used. Also note that if you do not specify a restriction, the value specified in the GUI (if any) will be used.

--thread-pool

The max number of worker threads to use. Default is 30

--timeout, -t

The server timeout in seconds. Default is 120

--url-prefix

Prefix to prepend to all URLs. Useful for reverseproxying to this server from Apache/nginx/etc.

--username

Username for access. By default, it is: ‘calibre’

--version

show program’s version number and exit

--with-library

Path to the library folder to serve with the content server


Table Of Contents

Previous topic

calibre-debug

Next topic

calibre-smtp

This Page