The paperless project has moved on to paperless-ng and the original paperless package in Nixpkgs has stopped working recently (due to version incompatibility with the providede Django package). Instead of investing more time into the old module we should migrate all users to the new module instead.launchpad/nixpkgs/master
Andreas Rammhold
3 years ago
committed by
Flakebi
parent
95f2dc650d
commit
6e1421013a
@ -1,183 +0,0 @@ |
||||
{ config, pkgs, lib, ... }: |
||||
|
||||
with lib; |
||||
let |
||||
cfg = config.services.paperless; |
||||
|
||||
defaultUser = "paperless"; |
||||
|
||||
manage = cfg.package.withConfig { |
||||
config = { |
||||
PAPERLESS_CONSUMPTION_DIR = cfg.consumptionDir; |
||||
PAPERLESS_INLINE_DOC = "true"; |
||||
PAPERLESS_DISABLE_LOGIN = "true"; |
||||
} // cfg.extraConfig; |
||||
inherit (cfg) dataDir ocrLanguages; |
||||
paperlessPkg = cfg.package; |
||||
}; |
||||
in |
||||
{ |
||||
options.services.paperless = { |
||||
enable = mkOption { |
||||
type = lib.types.bool; |
||||
default = false; |
||||
description = '' |
||||
Enable Paperless. |
||||
|
||||
When started, the Paperless database is automatically created if it doesn't |
||||
exist and updated if the Paperless package has changed. |
||||
Both tasks are achieved by running a Django migration. |
||||
''; |
||||
}; |
||||
|
||||
dataDir = mkOption { |
||||
type = types.str; |
||||
default = "/var/lib/paperless"; |
||||
description = "Directory to store the Paperless data."; |
||||
}; |
||||
|
||||
consumptionDir = mkOption { |
||||
type = types.str; |
||||
default = "${cfg.dataDir}/consume"; |
||||
defaultText = "\${dataDir}/consume"; |
||||
description = "Directory from which new documents are imported."; |
||||
}; |
||||
|
||||
consumptionDirIsPublic = mkOption { |
||||
type = types.bool; |
||||
default = false; |
||||
description = "Whether all users can write to the consumption dir."; |
||||
}; |
||||
|
||||
ocrLanguages = mkOption { |
||||
type = with types; nullOr (listOf str); |
||||
default = null; |
||||
description = '' |
||||
Languages available for OCR via Tesseract, specified as |
||||
<literal>ISO 639-2/T</literal> language codes. |
||||
If unset, defaults to all available languages. |
||||
''; |
||||
example = [ "eng" "spa" "jpn" ]; |
||||
}; |
||||
|
||||
address = mkOption { |
||||
type = types.str; |
||||
default = "localhost"; |
||||
description = "Server listening address."; |
||||
}; |
||||
|
||||
port = mkOption { |
||||
type = types.port; |
||||
default = 28981; |
||||
description = "Server port to listen on."; |
||||
}; |
||||
|
||||
extraConfig = mkOption { |
||||
type = types.attrs; |
||||
default = {}; |
||||
description = '' |
||||
Extra paperless config options. |
||||
|
||||
The config values are evaluated as double-quoted Bash string literals. |
||||
|
||||
See <literal>paperless-src/paperless.conf.example</literal> for available options. |
||||
|
||||
To enable user authentication, set <literal>PAPERLESS_DISABLE_LOGIN = "false"</literal> |
||||
and run the shell command <literal>$dataDir/paperless-manage createsuperuser</literal>. |
||||
|
||||
To define secret options without storing them in /nix/store, use the following pattern: |
||||
<literal>PAPERLESS_PASSPHRASE = "$(< /etc/my_passphrase_file)"</literal> |
||||
''; |
||||
example = literalExample '' |
||||
{ |
||||
PAPERLESS_OCR_LANGUAGE = "deu"; |
||||
} |
||||
''; |
||||
}; |
||||
|
||||
user = mkOption { |
||||
type = types.str; |
||||
default = defaultUser; |
||||
description = "User under which Paperless runs."; |
||||
}; |
||||
|
||||
package = mkOption { |
||||
type = types.package; |
||||
default = pkgs.paperless; |
||||
defaultText = "pkgs.paperless"; |
||||
description = "The Paperless package to use."; |
||||
}; |
||||
|
||||
manage = mkOption { |
||||
type = types.package; |
||||
readOnly = true; |
||||
default = manage; |
||||
description = '' |
||||
A script to manage the Paperless instance. |
||||
It wraps Django's manage.py and is also available at |
||||
<literal>$dataDir/manage-paperless</literal> |
||||
''; |
||||
}; |
||||
}; |
||||
|
||||
config = mkIf cfg.enable { |
||||
|
||||
systemd.tmpfiles.rules = [ |
||||
"d '${cfg.dataDir}' - ${cfg.user} ${config.users.users.${cfg.user}.group} - -" |
||||
] ++ (optional cfg.consumptionDirIsPublic |
||||
"d '${cfg.consumptionDir}' 777 - - - -" |
||||
# If the consumption dir is not created here, it's automatically created by |
||||
# 'manage' with the default permissions. |
||||
); |
||||
|
||||
systemd.services.paperless-consumer = { |
||||
description = "Paperless document consumer"; |
||||
serviceConfig = { |
||||
User = cfg.user; |
||||
ExecStart = "${manage} document_consumer"; |
||||
Restart = "always"; |
||||
}; |
||||
after = [ "systemd-tmpfiles-setup.service" ]; |
||||
wantedBy = [ "multi-user.target" ]; |
||||
preStart = '' |
||||
if [[ $(readlink ${cfg.dataDir}/paperless-manage) != ${manage} ]]; then |
||||
ln -sf ${manage} ${cfg.dataDir}/paperless-manage |
||||
fi |
||||
|
||||
${manage.setupEnv} |
||||
# Auto-migrate on first run or if the package has changed |
||||
versionFile="$PAPERLESS_DBDIR/src-version" |
||||
if [[ $(cat "$versionFile" 2>/dev/null) != ${cfg.package} ]]; then |
||||
python $paperlessSrc/manage.py migrate |
||||
echo ${cfg.package} > "$versionFile" |
||||
fi |
||||
''; |
||||
}; |
||||
|
||||
systemd.services.paperless-server = { |
||||
description = "Paperless document server"; |
||||
serviceConfig = { |
||||
User = cfg.user; |
||||
ExecStart = "${manage} runserver --noreload ${cfg.address}:${toString cfg.port}"; |
||||
Restart = "always"; |
||||
}; |
||||
# Bind to `paperless-consumer` so that the server never runs |
||||
# during migrations |
||||
bindsTo = [ "paperless-consumer.service" ]; |
||||
after = [ "paperless-consumer.service" ]; |
||||
wantedBy = [ "multi-user.target" ]; |
||||
}; |
||||
|
||||
users = optionalAttrs (cfg.user == defaultUser) { |
||||
users.${defaultUser} = { |
||||
group = defaultUser; |
||||
uid = config.ids.uids.paperless; |
||||
home = cfg.dataDir; |
||||
}; |
||||
|
||||
groups.${defaultUser} = { |
||||
gid = config.ids.gids.paperless; |
||||
}; |
||||
}; |
||||
}; |
||||
} |
||||
@ -1,36 +0,0 @@ |
||||
import ./make-test-python.nix ({ lib, ... } : { |
||||
name = "paperless"; |
||||
meta = with lib.maintainers; { |
||||
maintainers = [ earvstedt ]; |
||||
}; |
||||
|
||||
machine = { pkgs, ... }: { |
||||
environment.systemPackages = with pkgs; [ imagemagick jq ]; |
||||
services.paperless = { |
||||
enable = true; |
||||
ocrLanguages = [ "eng" ]; |
||||
}; |
||||
}; |
||||
|
||||
testScript = '' |
||||
machine.wait_for_unit("paperless-consumer.service") |
||||
|
||||
# Create test doc |
||||
machine.succeed( |
||||
"convert -size 400x40 xc:white -font 'DejaVu-Sans' -pointsize 20 -fill black -annotate +5+20 'hello world 16-10-2005' /var/lib/paperless/consume/doc.png" |
||||
) |
||||
|
||||
with subtest("Service gets ready"): |
||||
machine.wait_for_unit("paperless-server.service") |
||||
# Wait until server accepts connections |
||||
machine.wait_until_succeeds("curl -fs localhost:28981") |
||||
|
||||
with subtest("Test document is consumed"): |
||||
machine.wait_until_succeeds( |
||||
"(($(curl -fs localhost:28981/api/documents/ | jq .count) == 1))" |
||||
) |
||||
assert "2005-10-16" in machine.succeed( |
||||
"curl -fs localhost:28981/api/documents/ | jq '.results | .[0] | .created'" |
||||
) |
||||
''; |
||||
}) |
||||
@ -1,168 +0,0 @@ |
||||
{ stdenv |
||||
, lib |
||||
, fetchFromGitHub |
||||
, makeWrapper |
||||
, callPackage |
||||
|
||||
, python3 |
||||
, imagemagick |
||||
, ghostscript |
||||
, optipng |
||||
, tesseract |
||||
, unpaper |
||||
}: |
||||
|
||||
## Usage |
||||
|
||||
# ${paperless}/bin/paperless wraps manage.py |
||||
|
||||
# ${paperless}/share/paperless/setup-env.sh can be sourced from a |
||||
# shell script to setup a Paperless environment |
||||
|
||||
# paperless.withConfig is a convenience function to setup a |
||||
# configured Paperless instance. (See ./withConfig.nix) |
||||
|
||||
# For WSGI with gunicorn, use a shell script like this: |
||||
# let |
||||
# pythonEnv = paperless.python.withPackages (ps: paperless.runtimePackages ++ [ ps.gunicorn ]); |
||||
# in |
||||
# writers.writeBash "run-gunicorn" '' |
||||
# source ${paperless}/share/paperless/setup-env.sh |
||||
# PYTHONPATH=$paperlessSrc ${pythonEnv}/bin/gunicorn paperless.wsgi |
||||
# '' |
||||
|
||||
let |
||||
paperless = stdenv.mkDerivation rec { |
||||
pname = "paperless"; |
||||
version = "2.7.0"; |
||||
|
||||
src = fetchFromGitHub { |
||||
owner = "the-paperless-project"; |
||||
repo = "paperless"; |
||||
rev = version; |
||||
sha256 = "0pkmyky1crjnsg7r0gfk0fadisfsgzlsq6afpz16wx4hp6yvkkf7"; |
||||
}; |
||||
|
||||
nativeBuildInputs = [ makeWrapper ]; |
||||
|
||||
doCheck = true; |
||||
dontInstall = true; |
||||
|
||||
pythonEnv = python.withPackages (_: runtimePackages); |
||||
pythonCheckEnv = python.withPackages (_: (runtimePackages ++ checkPackages)); |
||||
|
||||
unpackPhase = '' |
||||
srcDir=$out/share/paperless |
||||
mkdir -p $srcDir |
||||
cp -r --no-preserve=mode $src/src/* $src/LICENSE $srcDir |
||||
''; |
||||
|
||||
postPatch = '' |
||||
# django-cors-headers 3.x requires a scheme for allowed hosts |
||||
substituteInPlace $out/share/paperless/paperless/settings.py \ |
||||
--replace "localhost:8080" "http://localhost:8080" |
||||
''; |
||||
|
||||
buildPhase = let |
||||
# Paperless has explicit runtime checks that expect these binaries to be in PATH |
||||
extraBin = lib.makeBinPath [ imagemagick ghostscript optipng tesseract unpaper ]; |
||||
in '' |
||||
${python.interpreter} -m compileall $srcDir |
||||
|
||||
makeWrapper $pythonEnv/bin/python $out/bin/paperless \ |
||||
--set PATH ${extraBin} --add-flags $out/share/paperless/manage.py |
||||
|
||||
# A shell snippet that can be sourced to setup a paperless env |
||||
cat > $out/share/paperless/setup-env.sh <<EOF |
||||
export PATH="$pythonEnv/bin:${extraBin}''${PATH:+:}$PATH" |
||||
export paperlessSrc=$out/share/paperless |
||||
EOF |
||||
''; |
||||
|
||||
checkPhase = '' |
||||
source $out/share/paperless/setup-env.sh |
||||
tmpDir=$(realpath testsTmp) |
||||
mkdir $tmpDir |
||||
export HOME=$tmpDir |
||||
export PAPERLESS_MEDIADIR=$tmpDir |
||||
cd $paperlessSrc |
||||
# Prevent tests from writing to the derivation output |
||||
chmod -R -w $out |
||||
# Disable cache to silence a pytest warning ("could not create cache") |
||||
$pythonCheckEnv/bin/pytest -p no:cacheprovider |
||||
''; |
||||
|
||||
passthru = { |
||||
withConfig = callPackage ./withConfig.nix {}; |
||||
inherit python runtimePackages checkPackages tesseract; |
||||
}; |
||||
|
||||
meta = with lib; { |
||||
description = "Scan, index, and archive all of your paper documents"; |
||||
homepage = "https://github.com/the-paperless-project/paperless"; |
||||
license = licenses.gpl3; |
||||
maintainers = [ maintainers.earvstedt ]; |
||||
}; |
||||
}; |
||||
|
||||
python = python3.override { |
||||
packageOverrides = self: super: let |
||||
customPkgs = import ./python-modules super fetchFromGitHub; in |
||||
{ |
||||
pyocr = pyocrWithUserTesseract super; |
||||
|
||||
# Paperless is incompatible with factory_boy >= 3 |
||||
factory_boy = customPkgs.factory_boy_2_12_0; |
||||
|
||||
# These are pre-release versions, hence they are private to this pkg |
||||
django-filter = self.callPackage ./python-modules/django-filter.nix {}; |
||||
django-crispy-forms = self.callPackage ./python-modules/django-crispy-forms.nix {}; |
||||
}; |
||||
}; |
||||
|
||||
runtimePackages = with python.pkgs; [ |
||||
dateparser |
||||
python-dateutil |
||||
django |
||||
django-cors-headers |
||||
django-crispy-forms |
||||
django-filter |
||||
django_extensions |
||||
djangoql |
||||
djangorestframework |
||||
factory_boy |
||||
filemagic |
||||
fuzzywuzzy |
||||
langdetect |
||||
pdftotext |
||||
pillow |
||||
psycopg2 |
||||
pyocr |
||||
python-dotenv |
||||
python-gnupg |
||||
pytz |
||||
termcolor |
||||
] ++ (lib.optional stdenv.isLinux inotify-simple); |
||||
|
||||
checkPackages = with python.pkgs; [ |
||||
pytest |
||||
pytest-django |
||||
pytest-env |
||||
pytest-xdist |
||||
]; |
||||
|
||||
pyocrWithUserTesseract = pyPkgs: |
||||
let |
||||
pyocr = pyPkgs.pyocr.override { inherit tesseract; }; |
||||
in |
||||
if pyocr.outPath == pyPkgs.pyocr.outPath then |
||||
pyocr |
||||
else |
||||
# The user has provided a custom tesseract derivation that might be |
||||
# missing some languages that are required for PyOCR's tests. Disable them to |
||||
# avoid build errors. |
||||
pyocr.overridePythonAttrs (attrs: { |
||||
doCheck = false; |
||||
}); |
||||
in |
||||
paperless |
||||
@ -1,11 +0,0 @@ |
||||
pyPkgs: fetchFromGitHub: |
||||
{ |
||||
factory_boy_2_12_0 = pyPkgs.factory_boy.overridePythonAttrs (old: rec { |
||||
version = "2.12.0"; |
||||
src = pyPkgs.fetchPypi { |
||||
inherit (old) pname; |
||||
inherit version; |
||||
sha256 = "0w53hjgag6ad5i2vmrys8ysk54agsqvgbjy9lg8g0d8pi9h8vx7s"; |
||||
}; |
||||
}); |
||||
} |
||||
@ -1,39 +0,0 @@ |
||||
{ lib |
||||
, buildPythonPackage |
||||
, fetchFromGitHub |
||||
, pytestCheckHook |
||||
, pytest-django |
||||
, django |
||||
}: |
||||
|
||||
buildPythonPackage rec { |
||||
pname = "django-crispy-forms"; |
||||
version = "1.10.0"; |
||||
|
||||
src = fetchFromGitHub { |
||||
owner = "django-crispy-forms"; |
||||
repo = "django-crispy-forms"; |
||||
rev = version; |
||||
sha256 = "0y6kskfxgckb9npcgwx4zrs5n9px159zh9zhinhxi3i7wlriqpf5"; |
||||
}; |
||||
|
||||
# For reasons unknown, the source dir must contain a dash |
||||
# for the tests to run successfully |
||||
postUnpack = '' |
||||
mv $sourceRoot source- |
||||
export sourceRoot=source- |
||||
''; |
||||
|
||||
checkInputs = [ django pytest-django pytestCheckHook ]; |
||||
|
||||
preCheck = '' |
||||
export DJANGO_SETTINGS_MODULE=crispy_forms.tests.test_settings |
||||
''; |
||||
|
||||
meta = with lib; { |
||||
description = "The best way to have DRY Django forms"; |
||||
homepage = "https://github.com/maraujop/django-crispy-forms"; |
||||
license = licenses.mit; |
||||
maintainers = with maintainers; [ earvstedt ]; |
||||
}; |
||||
} |
||||
@ -1,26 +0,0 @@ |
||||
{ lib, buildPythonPackage, python, pythonOlder, fetchFromGitHub |
||||
, django, django-crispy-forms, djangorestframework, mock, pytz }: |
||||
|
||||
buildPythonPackage rec { |
||||
pname = "django-filter"; |
||||
version = "2.1.0-pre"; |
||||
disabled = pythonOlder "3.4"; |
||||
|
||||
src = fetchFromGitHub { |
||||
owner = "carltongibson"; |
||||
repo = pname; |
||||
rev = "24adad8c48bc9e7c7539b6510ffde4ce4effdc29"; |
||||
sha256 = "0hv4w95jnlzp9vdximl6bb27fyi75001jhvsbs0ikkd8amq8iaj7"; |
||||
}; |
||||
|
||||
checkInputs = [ django django-crispy-forms djangorestframework mock pytz ]; |
||||
|
||||
checkPhase = "${python.interpreter} runtests.py"; |
||||
|
||||
meta = with lib; { |
||||
description = "A reusable Django application for allowing users to filter querysets dynamically."; |
||||
homepage = "https://github.com/carltongibson/django-filter"; |
||||
license = licenses.bsd3; |
||||
maintainers = with maintainers; [ earvstedt ]; |
||||
}; |
||||
} |
||||
@ -1,68 +0,0 @@ |
||||
{ paperless, lib, writers }: |
||||
|
||||
## Usage |
||||
# |
||||
# nix-build --out-link ./paperless -E ' |
||||
# (import <nixpkgs> {}).paperless.withConfig { |
||||
# dataDir = /tmp/paperless-data; |
||||
# config = { |
||||
# PAPERLESS_DISABLE_LOGIN = "true"; |
||||
# }; |
||||
# }' |
||||
# |
||||
# Setup DB |
||||
# ./paperless migrate |
||||
# |
||||
# Consume documents in ${dataDir}/consume |
||||
# ./paperless document_consumer --oneshot |
||||
# |
||||
# Start web interface |
||||
# ./paperless runserver --noreload localhost:8000 |
||||
|
||||
{ config ? {}, dataDir ? null, ocrLanguages ? null |
||||
, paperlessPkg ? paperless, extraCmds ? "" }: |
||||
with lib; |
||||
let |
||||
paperless = if ocrLanguages == null then |
||||
paperlessPkg |
||||
else |
||||
(paperlessPkg.override { |
||||
tesseract = paperlessPkg.tesseract.override { |
||||
enableLanguages = ocrLanguages; |
||||
}; |
||||
}).overrideDerivation (_: { |
||||
# `ocrLanguages` might be missing some languages required by the tests. |
||||
doCheck = false; |
||||
}); |
||||
|
||||
envVars = (optionalAttrs (dataDir != null) { |
||||
PAPERLESS_CONSUMPTION_DIR = "${dataDir}/consume"; |
||||
PAPERLESS_MEDIADIR = "${dataDir}/media"; |
||||
PAPERLESS_STATICDIR = "${dataDir}/static"; |
||||
PAPERLESS_DBDIR = dataDir; |
||||
}) // config; |
||||
|
||||
envVarDefs = mapAttrsToList (n: v: ''export ${n}="${toString v}"'') envVars; |
||||
setupEnvVars = builtins.concatStringsSep "\n" envVarDefs; |
||||
|
||||
setupEnv = '' |
||||
source ${paperless}/share/paperless/setup-env.sh |
||||
${setupEnvVars} |
||||
${optionalString (dataDir != null) '' |
||||
mkdir -p "$PAPERLESS_CONSUMPTION_DIR" \ |
||||
"$PAPERLESS_MEDIADIR" \ |
||||
"$PAPERLESS_STATICDIR" \ |
||||
"$PAPERLESS_DBDIR" |
||||
''} |
||||
''; |
||||
|
||||
runPaperless = writers.writeBash "paperless" '' |
||||
set -e |
||||
${setupEnv} |
||||
${extraCmds} |
||||
exec python $paperlessSrc/manage.py "$@" |
||||
''; |
||||
in |
||||
runPaperless // { |
||||
inherit paperless setupEnv; |
||||
} |
||||
Loading…
Reference in new issue