Skip to content

Commit e493e37

Browse files
committed
docs(readme.md): add docker, raspberry pi and language addition instructions
1 parent 94b4ffc commit e493e37

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,61 @@ References:
7272
```
7373
<!-- prettier-ignore-end -->
7474

75+
## Docker
76+
77+
Docker images are multi-arch images based on `alpine` variant of official `node`
78+
docker images supporting `linux/amd64`, `linux/arm/v6`, `linux/arm/v7`,
79+
`linux/arm64/v8` platforms.
80+
81+
## Raspberry Pi support
82+
83+
The docker images support ARM architectures which means that they can be used on
84+
at least the following versions of Raspberry Pi:
85+
86+
- RPi 1 Model A
87+
- RPi 1 Model A+
88+
- RPi 3 Model A+
89+
- RPi 1 Model B
90+
- RPi 1 Model B+
91+
- RPi 2 Model B
92+
- RPi 2 Model B v1.2 (:heavy_check_mark: tested)
93+
- RPi 3 Model B
94+
- RPi 3 Model B+ (:heavy_check_mark: tested)
95+
- RPi 4 Model B (:heavy_check_mark: tested)
96+
- Compute Module 1
97+
- Compute Module 3
98+
- Compute Module 3 Lite
99+
- Compute Module 3+
100+
- Compute Module 3+ Lite
101+
- RPi Zero PCB v1.2
102+
- RPi Zero PCB v1.3
103+
- RPi Zero W
104+
105+
If you have any of those devices and have successfully used the images feel free
106+
to report them and help update this list. :open_hands:
107+
108+
## Supported Languages
109+
110+
The container by default installs tesseract and 3 datapacks:
111+
112+
- `tesseract-ocr` - English (included)
113+
- `tesseract-ocr-data-deu` - German
114+
- `tesseract-ocr-data-pol` - Polish
115+
- `tesseract-ocr-data-rus` - Russian
116+
117+
To add more languages you can extend this image and install one or more
118+
[available language datapacks](https://pkgs.alpinelinux.org/packages?name=tesseract-ocr-data-*&branch=edge&arch=x86_64)
119+
with the package manager:
120+
121+
<!-- prettier-ignore-start -->
122+
```Dockerfile
123+
FROM hertzg/tesseract-server:latest
124+
RUN apk add --no-cache tesseract-ocr-data-spa tesseract-ocr-data-ara # and so on
125+
```
126+
<!-- prettier-ignore-end -->
127+
128+
After starting the container the new language will be automatically available.
129+
75130
## HTTP API
76131

77132
There are a few endpoints exposed this section describes each one.

0 commit comments

Comments
 (0)