Skip to content

README.md

Latest commit

 

History

History
40 lines (33 loc) · 2.63 KB

README.md

File metadata and controls

40 lines (33 loc) · 2.63 KB

s.containers/ocr-api

Back to index

Why?

Send pdf, png or jpg file to an OCR API and get either text or a PDF with the text overlayed on the original file back.

Environment Variables

Name Type Default Value Description
REDIS_ENABLED bool false If Redis is enabled for caching.
REDIS_HOST string localhost The host of the Redis server.
REDIS_PORT int 6379 The port of the Redis server.
AWS_REGION string us-east-1 The AWS region for S3.
S3_BUCKET string my-ocr-bucket The S3 bucket to store files.
AWS_ACCESS_KEY_ID string null The AWS access key ID for S3.
AWS_SECRET_ACCESS_KEY string null The AWS secret access key for S3.
ASYNC_CACHE_TTL int 600 The time to live for async cache in seconds.
FONT_PATH string /noto-sans.ttf The path to the font file used for text overlay.
PNG_QUALITY int 2 The quality of the PNG images generated from PDF pages.
BASIC_AUTH_USERNAME string null The username for basic authentication.
BASIC_AUTH_PASSWORD string null The password for basic authentication.

Example

services:
  app:
    image: ghcr.io/scolastico-dev/s.containers/ocr-api:latest
    restart: unless-stopped
    ports:
      - 3000:3000
    environment:
      AWS_ACCESS_KEY_ID: YOUR_AWS_ACCESS_KEY_ID
      AWS_SECRET_ACCESS_KEY: YOUR_AWS_SECRET_ACCESS_KEY
      AWS_REGION: eu-central-1
      S3_BUCKET: my-ocr-api-bucket