https://github.com/shelfio/aws-lambda-tesseract
6 MB Tesseract (with English training data) to fit inside AWS Lambda
https://github.com/shelfio/aws-lambda-tesseract
aws-lambda node-module nodejs npm-package ocr optical-character-recognition serverless tesseract
Last synced: 3 months ago
JSON representation
6 MB Tesseract (with English training data) to fit inside AWS Lambda
- Host: GitHub
- URL: https://github.com/shelfio/aws-lambda-tesseract
- Owner: shelfio
- License: mit
- Created: 2018-07-26T19:24:37.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-27T01:55:33.000Z (3 months ago)
- Last Synced: 2025-03-28T19:44:53.163Z (3 months ago)
- Topics: aws-lambda, node-module, nodejs, npm-package, ocr, optical-character-recognition, serverless, tesseract
- Language: Shell
- Homepage:
- Size: 41 MB
- Stars: 90
- Watchers: 24
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# aws-lambda-tesseract [](https://circleci.com/gh/shelfio/aws-lambda-tesseract/tree/master)  [](bin/)
> 6 MB Tesseract 5.3.3 (with English training data) to fit inside AWS Lambda
Inspired by [chrome-aws-lambda](https://github.com/alixaxel/chrome-aws-lambda) & [lambda-scanner-ocr](https://github.com/philippkeller/lambda-scanner-ocr)
## Install
```
$ yarn add @shelf/aws-lambda-tesseract
```
`1.x` versions of this library were compiled for Node 8.10.
`2.x` was compiled for Node 10.x runtime.
`3.x` works for Node 12.x runtime.
`4.x` works for Node 16.x runtime and compiled with **Tesseract 5.1.0**. It works with x86_64 CPUs for now only.
`5.x` works for Node 18.x runtime and compiled with **Tesseract 5.3.3**. It works with arm64 CPUs.
`6.x` works for Node 22.x runtime and compiled with **Tesseract 5.3.3**. It works with arm64 CPUs.
## How does it work?
This package contains an archive with [Tesseract 5.3.3](https://github.com/tesseract-ocr/tesseract) compiled for usage in AWS Lambda environment.
When a Lambda starts, it unpacks an archive with a binary to the `/tmp` folder and makes sure it's done only once per Lambda cold start.
## Usage
```js
const {getTextFromImage, isSupportedFile} = require('@shelf/aws-lambda-tesseract');
module.exports.handler = async event => {
// assuming there is a photo.jpg inside /tmp dir
// original file will be deleted afterwards
if (!isSupportedFile('/tmp/photo.jpg')) {
return false;
}
return getTextFromImage('/tmp/photo.jpg');
};
```
`isSupportedFile` checks that file has image-like file extension and it's not in the list of
unsupported by Tesseract file extensions.
## Compile It Yourself
See [compile-tesseract.sh](compile-tesseract.sh)
Smoke test that it works by running `test.sh` script
## See Also
- [aws-lambda-libreoffice](https://github.com/shelfio/aws-lambda-libreoffice)
- [chrome-aws-lambda-layer](https://github.com/shelfio/chrome-aws-lambda-layer)
- [ghostscript-lambda-layer](https://github.com/shelfio/ghostscript-lambda-layer)
## Publish
```sh
$ git checkout master
$ yarn version
$ yarn publish
$ git push origin master --tags
```
## License
MIT © [Shelf](https://shelf.io)