Sign inSign up

devzwf/brscan-skey

By devzwf

•Updated about 7 hours ago

Image
1

280

devzwf/brscan-skey repository overview

⁠brscan-skey

VersionPullsSizeGitHubLicense

Press SCAN → Scan to PC on a Brother network scanner and get a multi-page PDF in a folder, such as the Paperless-ngx consume folder or a share.

Use it on Brother models without a "Scan to FTP / Network" menu (many North American models).

šŸ“– Full documentation, troubleshooting and source code: github.com/devzwf/brscan-skey-docker⁠

⁠Supported tags

TagDescription
latestLatest release
1.0, 1.0.1Pinned version, see the changelog⁠

Platform: linux/amd64 only, because Brother ships x86 drivers only. Every tag is rebuilt weekly for Debian security updates.

⁠Before you start

  1. Run the container with host networking. The device sends the button event to UDP port 54925.
  2. On the device web page, go to Network → Network → Protocol → SNMP and choose SNMP v1/v2c read-write access. Otherwise the device shows "No PC found".

⁠Quick start

services:
  brscan-skey:
    image: devzwf/brscan-skey:latest
    container_name: brscan-skey
    network_mode: host
    restart: unless-stopped
    environment:
      SCANNER_IP: 192.168.1.50      # your Brother device
      SCANNER_MODEL: DCP-L2550DW    # exact model name
      SKEY_USER: Paperless          # name shown on the device
      TZ: America/Toronto
    volumes:
      - /path/to/paperless/consume:/output

Then press SCAN → Scan to PC → File → OK on the device.

Supported models (about 400, brscan4 driver):

docker run --rm --entrypoint list-models devzwf/brscan-skey

⁠Main settings

VariableDefault
SCANNER_IPrequiredDevice IP address
SCANNER_MODELrequiredModel name, e.g. DCP-L2550DW
SKEY_USERbrscanName shown in the Scan to PC menu
SCAN_RESOLUTION300dpi
SCAN_MODETrue GrayBlack & White, True Gray, 24bit Color[Fast]…
SCAN_PAGE_SIZELetterLetter, A4, Legal
PUID / PGID99 / 100Owner of the PDF files

All variables are listed in the README on GitHub⁠.

⁠Unraid

The template is available in Community Applications: search for brscan-skey.

⁠Support

Report bugs and ask questions in GitHub issues⁠.


The scripts are under the MIT license. The Brother drivers are redistributed under the Brother License Agreement⁠. This project is not affiliated with Brother Industries, Ltd.

ko-fi Buy me a coffee

Tag summary

Content type

Image

Digest

sha256:749653abc…

Size

110.5 MB

Last updated

about 7 hours ago

docker pull devzwf/brscan-skey