Skip to content

Command Line Interface

Ozzie Isaacs edited this page Sep 2, 2025 · 17 revisions

Command line options

Starting the script with -h lists all supported command line options.
Currently several options are supported, which are useful for running multiple instances of Calibre-Web, and other administrative tasks.

-p path allows to specify the location of the settings database
-g path allows to specify the location of the google-drive database
-c path allows to specify the location of SSL certfile, works only in combination with keyfile
-k path allows to specify the location of SSL keyfile, works only in combination with certfile
-v shows the current version info and exits
-i ip-address limits the listening address of the server to the given ip-address
-s user:password changes the password of user to password and ends Calibre-Web
-l Allows loading covers from localhost and local network
-d Dry run of updater to check file permissions in advance, exits Calibre-Web afterwards
-r Enable public database reconnect route under /reconnect
-o Allows to specify path and name Calibre-Web logfile

Starting Calibre-Web with -k "" -c "", deactivates the ssl-server, it falls back to non-ssl, so you can change the ssl settings.

Environmental variables

Calibre-Web supports the following Environmental variables.

SECRET_KEY sets the key to encrypt cookies (if not set calibre-web will generate a random key on it's own)
COOKIE_PREFIX adds a prefix to the session cookies, so it doesn't interfere with session cookies on the same server
CALIBRE_DBPATH allows to set the home directory for Calibre-Web's settings files (app.db, calibre-web.log, gdrive.db)
CALIBRE_PORT allows to set the default listening port during creation of the settings database. Afterwards the port which is configured in the UI, is used.
CALIBRE_RECONNECT enables the reconnect endpoint (<hostname>/reconnect) which will attempt to reconnect the database
CALIBRE_LOCALHOST allows loading covers from localhost and local network
CALIBRE_UNIX_SOCKET allows to run Calibre-Web on a specified unix-socket, needs gevent

FLASK_DEBUG redirects log output to console and sets log level to DEBUG for easier debugging. Creates hashes for static files to make the browser aware of changes

Clone this wiki locally