Paperless-ngx: Difference between revisions
Inital page |
No edit summary |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{application infobox | |||
|name=Paperless-ngx | |||
|type=Container | |||
|image=Paperless-ngx-logo.svg | |||
|firstRelease=March 2022 | |||
|latestRelease=2.16.3 | |||
|status=Active | |||
|license=GNU General Public License v3.0 or later | |||
|os=Cross-platform | |||
|platform=Docker | |||
|programmingLanguage=Python, TypeScript | |||
|website=[https://paperless-ngx.com paperless-ngx.com] | |||
|github=paperless-ngx/paperless-ngx | |||
|bugTracker=[https://github.com/paperless-ngx/paperless-ngx/issues GitHub Issues] | |||
|documentation=[https://docs.paperless-ngx.com Paperless-ngx Documentation] | |||
}} | |||
[https://paperless-ngx.com Paperless-ngx] is a community-supported open-source document management system that transforms your physical documents into a searchable online archive, allowing you to reduce paper clutter. | [https://paperless-ngx.com Paperless-ngx] is a community-supported open-source document management system that transforms your physical documents into a searchable online archive, allowing you to reduce paper clutter. | ||
| Line 7: | Line 23: | ||
passwordFile = "/etc/paperless-admin-pass"; | passwordFile = "/etc/paperless-admin-pass"; | ||
};}}After applying the configuration you can access the instance via http://localhost:28981 and login with username <code>admin</code> and password <code>admin</code>. | };}}After applying the configuration you can access the instance via http://localhost:28981 and login with username <code>admin</code> and password <code>admin</code>. | ||
Another example below could be used on a server with an actual URL and some extra settings.<syntaxhighlight lang="nix"> | |||
services.paperless = { | |||
enable = true; | |||
consumptionDirIsPublic = true; | |||
settings = { | |||
PAPERLESS_CONSUMER_IGNORE_PATTERN = [ | |||
".DS_STORE/*" | |||
"desktop.ini" | |||
]; | |||
PAPERLESS_OCR_LANGUAGE = "deu+eng"; | |||
PAPERLESS_OCR_USER_ARGS = { | |||
optimize = 1; | |||
pdfa_image_compression = "lossless"; | |||
}; | |||
PAPERLESS_URL = "https://paperless.example.com"; | |||
}; | |||
}; | |||
</syntaxhighlight>After the installation, you can set an admin user yourself via the following command on the server <syntaxhighlight lang="bash"> | |||
sudo paperless-manage createsuperuser | |||
</syntaxhighlight> | |||
[[Category:Server]] | |||
[[Category:Web Applications]] | |||
Latest revision as of 15:28, 9 June 2025
Paperless-ngx is a community-supported open-source document management system that transforms your physical documents into a searchable online archive, allowing you to reduce paper clutter.
Setup
The following example configuration will enable Paperless locally
❄︎ /etc/nixos/configuration.nix
environment.etc."paperless-admin-pass".text = "admin";
services.paperless = {
enable = true;
passwordFile = "/etc/paperless-admin-pass";
};
After applying the configuration you can access the instance via http://localhost:28981 and login with username admin and password admin.
Another example below could be used on a server with an actual URL and some extra settings.
services.paperless = {
enable = true;
consumptionDirIsPublic = true;
settings = {
PAPERLESS_CONSUMER_IGNORE_PATTERN = [
".DS_STORE/*"
"desktop.ini"
];
PAPERLESS_OCR_LANGUAGE = "deu+eng";
PAPERLESS_OCR_USER_ARGS = {
optimize = 1;
pdfa_image_compression = "lossless";
};
PAPERLESS_URL = "https://paperless.example.com";
};
};
After the installation, you can set an admin user yourself via the following command on the server
sudo paperless-manage createsuperuser