diff options
author | Pavel Borzenkov <pavel@borzenkov.net> | 2021-02-22 14:10:46 +0300 |
---|---|---|
committer | Pavel Borzenkov <pavel@borzenkov.net> | 2021-03-21 17:10:12 +0300 |
commit | f069cdb0dce80bb91055d94cca5c0a21b48b7fcd (patch) | |
tree | e0e29eea010ab5c6d78dc4f79c8b812e9bf5627b /pkgs/servers/calibre-web | |
parent | 6259a47c45a11e8097464446660318873edc23d1 (diff) |
calibre-web: init at 0.6.11
There are two patches applied to 'calibre-web' in order to make it more NixOS friendly: - default-logger.patch switches default log output to /dev/stdout, as otherwise calibre-web tries to open a file relative to its location, which it can't do as the store is read-only. It's not possible to pass log file location via command line flags. - run-migrations.patch adds an env var __RUN_MIGRATIONS_AND_EXIT that, when set, instructs calibre-web to run DB migrations and exit. As almost all config parameters are configured via UI in sqlite3 DB, this patch allows the DB to be pre-created so it can be updated by systemd pre-start script later. Thus, allowing calibre-web to be configured declaratively.
Diffstat (limited to 'pkgs/servers/calibre-web')
-rw-r--r-- | pkgs/servers/calibre-web/db-migrations.patch | 14 | ||||
-rw-r--r-- | pkgs/servers/calibre-web/default-logger.patch | 17 | ||||
-rw-r--r-- | pkgs/servers/calibre-web/default.nix | 69 |
3 files changed, 100 insertions, 0 deletions
diff --git a/pkgs/servers/calibre-web/db-migrations.patch b/pkgs/servers/calibre-web/db-migrations.patch new file mode 100644 index 0000000000000..87e63f7d95c2b --- /dev/null +++ b/pkgs/servers/calibre-web/db-migrations.patch @@ -0,0 +1,14 @@ +diff --git a/cps/__init__.py b/cps/__init__.py +index 627cca0b..233bb2dd 100644 +--- a/cps/__init__.py ++++ b/cps/__init__.py +@@ -87,6 +87,9 @@ db.CalibreDB.setup_db(config, cli.settingspath) + + calibre_db = db.CalibreDB() + ++if os.environ.get('__RUN_MIGRATIONS_AND_EXIT'): ++ sys.exit(0) ++ + def create_app(): + app.wsgi_app = ReverseProxied(app.wsgi_app) + # For python2 convert path to unicode diff --git a/pkgs/servers/calibre-web/default-logger.patch b/pkgs/servers/calibre-web/default-logger.patch new file mode 100644 index 0000000000000..c5aecbd3d10cc --- /dev/null +++ b/pkgs/servers/calibre-web/default-logger.patch @@ -0,0 +1,17 @@ +diff --git a/cps/logger.py b/cps/logger.py +index b204de31..3206e2bf 100644 +--- a/cps/logger.py ++++ b/cps/logger.py +@@ -32,10 +32,10 @@ ACCESS_FORMATTER_TORNADO = Formatter("[%(asctime)s] %(message)s") + + FORMATTER = Formatter("[%(asctime)s] %(levelname)5s {%(name)s:%(lineno)d} %(message)s") + DEFAULT_LOG_LEVEL = logging.INFO +-DEFAULT_LOG_FILE = os.path.join(_CONFIG_DIR, "calibre-web.log") +-DEFAULT_ACCESS_LOG = os.path.join(_CONFIG_DIR, "access.log") + LOG_TO_STDERR = '/dev/stderr' + LOG_TO_STDOUT = '/dev/stdout' ++DEFAULT_LOG_FILE = LOG_TO_STDOUT ++DEFAULT_ACCESS_LOG = LOG_TO_STDOUT + + logging.addLevelName(logging.WARNING, "WARN") + logging.addLevelName(logging.CRITICAL, "CRIT") diff --git a/pkgs/servers/calibre-web/default.nix b/pkgs/servers/calibre-web/default.nix new file mode 100644 index 0000000000000..2886d96f0fcf1 --- /dev/null +++ b/pkgs/servers/calibre-web/default.nix @@ -0,0 +1,69 @@ +{ lib +, fetchFromGitHub +, python3 +, python3Packages +}: + +python3.pkgs.buildPythonApplication rec { + pname = "calibre-web"; + version = "0.6.11"; + + src = fetchFromGitHub { + owner = "janeczku"; + repo = "calibre-web"; + rev = version; + sha256 = "10sjllhhcamswpa1wlim4mbm2zl4g804bwly5p4nmklg7n1v226g"; + }; + + prePatch = '' + substituteInPlace setup.cfg \ + --replace "requests>=2.11.1,<2.25.0" "requests>=2.11.1,<2.26.0" \ + --replace "cps = calibreweb:main" "calibre-web = calibreweb:main" + ''; + + patches = [ + # default-logger.patch switches default logger to /dev/stdout. Otherwise calibre-web tries to open a file relative + # to its location, which can't be done as the store is read-only. Log file location can later be configured using UI + # if needed. + ./default-logger.patch + # DB migrations adds an env var __RUN_MIGRATIONS_ANDEXIT that, when set, instructs calibre-web to run DB migrations + # and exit. This is gonna be used to configure calibre-web declaratively, as most of its configuration parameters + # are stored in the DB. + ./db-migrations.patch + ]; + + # calibre-web doesn't follow setuptools directory structure. The following is taken from the script + # that calibre-web's maintainer is using to package it: + # https://github.com/OzzieIsaacs/calibre-web-test/blob/master/build/make_release.py + postPatch = '' + mkdir -p src/calibreweb + mv cps.py src/calibreweb/__init__.py + mv cps src/calibreweb + ''; + + # Upstream repo doesn't provide any tests. + doCheck = false; + + propagatedBuildInputs = with python3Packages; [ + backports_abc + flask-babel + flask_login + flask_principal + iso-639 + pypdf2 + requests + singledispatch + sqlalchemy + tornado + unidecode + Wand + ]; + + meta = with lib; { + description = "Web app for browsing, reading and downloading eBooks stored in a Calibre database"; + maintainers = with maintainers; [ pborzenkov ]; + homepage = "https://github.com/janeczku/calibre-web"; + license = licenses.gpl3Plus; + platforms = platforms.all; + }; +} |