# scanserv-js

[scanservjs][0] is an open source, web-based front-end for the [SANE][1]
software suite.  It provides a simple graphical user interface for scanning
photos and documents using any local or network-connected SANE-compatible
scanner.

## Installation

```sh
kubectl apply -k scanservjs
```

Environment variables used by the [container image][2] can be set in the
`scanservjs.env` file.


## Integration with *paperless-ngx*

[paperless-ngx][3] is an open-source, web-based document management platform.
Integrating *scanservjs* with *paperless-ngx* allows scanned documents to be
fed automatically into the document management system for OCR, analysis, and
classification.  This integration is performed using the `afterScan` hook in
the *scanservjs* `config.local.js` file and the *paperless-ngx* REST API to
upload documents scanned as PDF files.

To enable the integration, specify the URL to the *paperless-ngx* service in
the `PAPERLESS_URL` environment variable.  Additionally, create an
[authentication token][4] for *paperless-ngx* user, store it in a file, and set
the `PAPERLESS_TOKEN_FILE` environment variable to the file path.

[0]: https://github.com/sbs20/scanservjs
[1]: http://sane-project.org/
[2]: https://github.com/sbs20/scanservjs/blob/master/docs/docker.md
[3]: https://docs.paperless-ngx.com/
[4]: https://docs.paperless-ngx.com/api/#authorization