Skip to content

PAPERLESS_TOKEN_FILE Support #1463 #1464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
manuc66 merged 2 commits into from
Dec 4, 2025
Merged

PAPERLESS_TOKEN_FILE Support #1463 #1464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5ef838
Add support for PAPERLESS_TOKEN_FILE environment variable
shubh2294 Nov 23, 2025
9a7af8f
fix #1474
manuc66 Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 37 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,8 @@ Run `npx node-hp-scan-to --help` to see the full list of options below:
| `-k`, `--keep-files` | Retain scanned files after uploading to Paperless-ngx or Nextcloud (disabled by default). | `-k` (disabled by default) |
| `-l`, `--label` | The name of the computer running this app. Defaults to the hostname. | `-l <hostname>` (default: system hostname) |
| `-n`, `--name` | Printer name (quote if it contains spaces). | `-n "Officejet 6500 E710n-z"` (no default) |
| `-o`, `--paperless-token` | Paperless-ngx API token. | `-o xxxxxxxxxxxx` (no default) |
| `-o`, `--paperless-token` | The paperless token. Required unless `----paperless-token-file` is used. Overrides if both are provided. | `-o xxxxxxxxxxxx` (no default) |
| `--paperless-token-file` | File name that contains the paperless token. Required unless `---paperless-token` is used. Takes precedence if both are provided.| `--paperless-token-file some/path/to/file` (no default) |
| `-p`, `--pattern` | Filename pattern (no extension). Use quotes for static text, supports date/time masks (see [dateformat docs](https://www.npmjs.com/package/dateformat#mask-options)). Defaults to `scan<increasing number>_page<page number>`. | `-p scan1_page1` |
| `-r`, `--resolution` | Scan resolution in DPI. Defaults to 200. | `-r 200` |
| `--mode <mode> ` | Selects the scan mode (default: Color) (choices: "Gray", "Color"). | `--mode Gray` |
Expand Down Expand Up @@ -208,15 +209,16 @@ Options:

Paperless Options:
-s, --paperless-post-document-url <paperless_post_document_url> The paperless post document url (example: https://domain.tld/api/documents/post_document/)
-o, --paperless-token <paperless_token> The paperless token
-o, --paperless-token <paperless_token> The paperless token. Either this or paperless-token-file is required for paperless integration.
--paperless-token-file <paperless_token_file> File name that contains the paperless token. Either this or paperless-token is required for paperless integration.
--paperless-group-multi-page-scan-into-a-pdf Combine multiple scanned images into a single PDF document
--paperless-always-send-as-pdf-file Always convert scan job to pdf before sending to paperless

Nextcloud Options:
--nextcloud-url <nextcloud_url> The nextcloud url (example: https://domain.tld)
--nextcloud-username <nextcloud_username> The nextcloud username
--nextcloud-password <nextcloud_app_password> The nextcloud app password for username. Either this or nextcloud-password-file is required
--nextcloud-password-file <nextcloud_app_password_file> File name that contains the nextcloud app password for username. Either this or nextcloud-password is required
--nextcloud-password <nextcloud_app_password> The nextcloud app password for username. Either this or nextcloud-password-file is required for nextcloud integration.
--nextcloud-password-file <nextcloud_app_password_file> File name that contains the nextcloud app password for username. Either this or nextcloud-password is required for nextcloud integration.
--nextcloud-upload-folder <nextcloud_upload_folder> The upload folder where documents or images are uploaded (default: scan)

Device Control Screen Options:
Expand Down Expand Up @@ -273,15 +275,16 @@ Options:

Paperless Options:
-s, --paperless-post-document-url <paperless_post_document_url> The paperless post document url (example: https://domain.tld/api/documents/post_document/)
-o, --paperless-token <paperless_token> The paperless token
-o, --paperless-token <paperless_token> The paperless token. Either this or paperless-token-file is required for paperless integration.
--paperless-token-file <paperless_token_file> File name that contains the paperless token. Either this or paperless-token is required for paperless integration.
--paperless-group-multi-page-scan-into-a-pdf Combine multiple scanned images into a single PDF document
--paperless-always-send-as-pdf-file Always convert scan job to pdf before sending to paperless

Nextcloud Options:
--nextcloud-url <nextcloud_url> The nextcloud url (example: https://domain.tld)
--nextcloud-username <nextcloud_username> The nextcloud username
--nextcloud-password <nextcloud_app_password> The nextcloud app password for username. Either this or nextcloud-password-file is required
--nextcloud-password-file <nextcloud_app_password_file> File name that contains the nextcloud app password for username. Either this or nextcloud-password is required
--nextcloud-password <nextcloud_app_password> The nextcloud app password for username. Either this or nextcloud-password-file is required for nextcloud integration.
--nextcloud-password-file <nextcloud_app_password_file> File name that contains the nextcloud app password for username. Either this or nextcloud-password is required for nextcloud integration.
--nextcloud-upload-folder <nextcloud_upload_folder> The upload folder where documents or images are uploaded (default: scan)

Auto-scan Options:
Expand Down Expand Up @@ -366,15 +369,16 @@ Options:

Paperless Options:
-s, --paperless-post-document-url <paperless_post_document_url> The paperless post document url (example: https://domain.tld/api/documents/post_document/)
-o, --paperless-token <paperless_token> The paperless token
-o, --paperless-token <paperless_token> The paperless token. Either this or paperless-token-file is required for paperless integration.
--paperless-token-file <paperless_token_file> File name that contains the paperless token. Either this or paperless-token is required for paperless integration.
--paperless-group-multi-page-scan-into-a-pdf Combine multiple scanned images into a single PDF document
--paperless-always-send-as-pdf-file Always convert scan job to pdf before sending to paperless

Nextcloud Options:
--nextcloud-url <nextcloud_url> The nextcloud url (example: https://domain.tld)
--nextcloud-username <nextcloud_username> The nextcloud username
--nextcloud-password <nextcloud_app_password> The nextcloud app password for username. Either this or nextcloud-password-file is required
--nextcloud-password-file <nextcloud_app_password_file> File name that contains the nextcloud app password for username. Either this or nextcloud-password is required
--nextcloud-password <nextcloud_app_password> The nextcloud app password for username. Either this or nextcloud-password-file is required for nextcloud integration.
--nextcloud-password-file <nextcloud_app_password_file> File name that contains the nextcloud app password for username. Either this or nextcloud-password is required for nextcloud integration.
--nextcloud-upload-folder <nextcloud_upload_folder> The upload folder where documents or images are uploaded (default: scan)

Global Options:
Expand Down Expand Up @@ -411,28 +415,29 @@ All scanned files are written to the volume `/scan`, the filename can be changed

List of supported environment variables and their meaning, or correspondence with [command-line flags](#cli-options):

| Environment Variable | Description | Corresponding CLI Flag or Notes |
|-------------------------------|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| `CMDLINE` | Additional command-line flags added at the end of the command | Set to `-D` to enable debug logs |
| `DIR` | Directory to use | `-d` / `--directory` |
| `IP` | IP address for the program | `-a` / `--address` |
| `KEEP_FILES` | If set, scanned files are not deleted after uploading to Paperless-ngx or Nextcloud | |
| `LABEL` | Label to set on the device's display as a scan target | `-l` / `--label` |
| `NAME` | Name of the device to lookup for on the network | `-n` / `--name` |
| `ADD_EMULATED_DUPLEX` | Enable emulated duplex scanning, with optional assembly mode (default: document-wise) | `--add-emulated-duplex [mode]` |
| `NEXTCLOUD_PASSWORD` | Password of Nextcloud user (either this or `NEXTCLOUD_PASSWORD_FILE` is required; file takes precedence) | |
| `NEXTCLOUD_PASSWORD_FILE` | File containing Nextcloud user password (either this or `NEXTCLOUD_PASSWORD` is required; takes precedence) | Example: `./nextcloud_password.secret` (preferred for Docker Compose secrets) |
| `NEXTCLOUD_UPLOAD_FOLDER` | Upload folder for documents or images (user must have write permission; defaults to `scan` if not set) | |
| `NEXTCLOUD_URL` | Nextcloud URL | Example: `https://nextcloud.example.tld` |
| `NEXTCLOUD_USERNAME` | Nextcloud username | |
| `PAPERLESS_POST_DOCUMENT_URL` | Paperless-ngx post document URL (if provided with token, a PDF is uploaded) | Example: `http://<paperless-host>:<port>/api/documents/post_document/` |
| `PAPERLESS_TOKEN` | Paperless-ngx API token | Example: `xxxxxxxxxxxx...` |
| `PATTERN` | Pattern to use | `-p` / `--pattern` |
| `PGID` | ID of the group that will run the program | |
| `PUID` | ID of the user that will run the program | |
| `RESOLUTION` | Resolution setting | `-r` / `--resolution` |
| `MODE` | Scan mode setting | `--mode` |
| `TEMP_DIR` | Temporary directory | `-t` / `--temp-directory` |
| Environment Variable | Description | Corresponding CLI Flag or Notes |
|-------------------------------|---------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| `CMDLINE` | Additional command-line flags added at the end of the command | Set to `-D` to enable debug logs |
| `DIR` | Directory to use | `-d` / `--directory` |
| `IP` | IP address for the program | `-a` / `--address` |
| `KEEP_FILES` | If set, scanned files are not deleted after uploading to Paperless-ngx or Nextcloud | |
| `LABEL` | Label to set on the device's display as a scan target | `-l` / `--label` |
| `NAME` | Name of the device to lookup for on the network | `-n` / `--name` |
| `ADD_EMULATED_DUPLEX` | Enable emulated duplex scanning, with optional assembly mode (default: document-wise) | `--add-emulated-duplex [mode]` |
| `NEXTCLOUD_PASSWORD` | Password of Nextcloud user (either this or `NEXTCLOUD_PASSWORD_FILE` is required; file takes precedence) | |
| `NEXTCLOUD_PASSWORD_FILE` | File containing Nextcloud user password (either this or `NEXTCLOUD_PASSWORD` is required; takes precedence) | Example: `./nextcloud_password.secret` (preferred for Docker Compose secrets) |
| `NEXTCLOUD_UPLOAD_FOLDER` | Upload folder for documents or images (user must have write permission; defaults to `scan` if not set) | |
| `NEXTCLOUD_URL` | Nextcloud URL | Example: `https://nextcloud.example.tld` |
| `NEXTCLOUD_USERNAME` | Nextcloud username | |
| `PAPERLESS_POST_DOCUMENT_URL` | Paperless-ngx post document URL (if provided with token, a PDF is uploaded) | Example: `http://<paperless-host>:<port>/api/documents/post_document/` |
| `PAPERLESS_TOKEN` | Paperless-ngx API token (either this or `NEXTCLOUD_PASSWORD_FILE` is required; file takes precedence) | Example: `xxxxxxxxxxxx...` |
| `PAPERLESS_TOKEN_FILE` | File containing paperless-ngx API token (either this or `PAPERLESS_TOKEN_FILE` is required; takes precedence) | Example: `./paperless_token.secret` (preferred for Docker Compose secrets) |
| `PATTERN` | Pattern to use | `-p` / `--pattern` |
| `PGID` | ID of the group that will run the program | |
| `PUID` | ID of the user that will run the program | |
| `RESOLUTION` | Resolution setting | `-r` / `--resolution` |
| `MODE` | Scan mode setting | `--mode` |
| `TEMP_DIR` | Temporary directory | `-t` / `--temp-directory` |

**Additional Notes:**

Expand Down
4 changes: 3 additions & 1 deletion root/app.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ if [ -n "$PAPERLESS_POST_DOCUMENT_URL" ]; then
ARGS+=("-s" "$PAPERLESS_POST_DOCUMENT_URL")
fi

if [ -n "$PAPERLESS_TOKEN" ]; then
if [ -n "$PAPERLESS_TOKEN_FILE" ]; then
ARGS+=("--paperless-token-file" "$PAPERLESS_TOKEN_FILE")
elif [ -n "$PAPERLESS_TOKEN" ]; then
ARGS+=("-o" "$PAPERLESS_TOKEN")
fi

Expand Down
Loading
Loading