https://github.com/novaardiansyah/ocr-server
Tesseract OCR Server
https://github.com/novaardiansyah/ocr-server
express-js tesseract-ocr ubuntu
Last synced: 2 months ago
JSON representation
Tesseract OCR Server
- Host: GitHub
- URL: https://github.com/novaardiansyah/ocr-server
- Owner: novaardiansyah
- License: mit
- Created: 2025-12-18T18:43:08.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-12-29T07:03:23.000Z (6 months ago)
- Last Synced: 2026-01-01T04:29:04.007Z (6 months ago)
- Topics: express-js, tesseract-ocr, ubuntu
- Language: JavaScript
- Homepage: https://ocr-server.novadev.my.id
- Size: 38.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Tesseract OCR Server
Hi Future Developer,
Welcome to the **Tesseract OCR Server**! This project is a simple and efficient OCR (Optical Character Recognition) API server built with Node.js and Express.js, powered by [Tesseract OCR engine](https://github.com/tesseract-ocr/tesseract).
This server allows you to extract text from images by sending base64-encoded image data through a REST API. It's designed for easy integration with other applications that need OCR capabilities.
## Dazzling Tech Stack! ⚡
- [Express.js](https://expressjs.com/)
- [Tesseract OCR](https://github.com/tesseract-ocr/tesseract)
## Installation Guide 🛠️
### Prerequisites
Before running this project, you need to install Tesseract OCR on your system.
#### Ubuntu 22.04
```bash
sudo apt update
sudo apt install -y tesseract-ocr tesseract-ocr-eng
```
Verify the installation:
```bash
tesseract --version
```
### Project Setup
1. **Clone the repository**
```bash
git clone https://github.com/novaardiansyah/ocr-server.git
cd ocr-server
```
2. **Install dependencies**
```bash
npm install
```
3. **Configure environment variables**
```bash
cp .env.example .env
```
Edit the `.env` file and set your configuration:
```env
API_KEY=your_secure_api_key_here
PORT=3000
```
4. **Run the server**
```bash
node index.js
```
The server will start on the configured port (default: 3000).
### Running with PM2 (Production)
For production deployment, you can use PM2 process manager:
```bash
npm run pm2:start
```
Other PM2 commands:
```bash
npm run pm2:stop # Stop the server
npm run pm2:restart # Restart the server
npm run pm2:delete # Delete the PM2 process
```
## API Documentation 📚
### Health Check
Check if the server is running.
**Endpoint:** `GET /health`
**Authentication:** Not required
**Response:**
```json
{
"status": "ok",
"timestamp": "2025-12-18T17:49:12.342Z"
}
```
### OCR - Extract Text from Image
Extract text from a base64-encoded image using Tesseract OCR.
**Endpoint:** `POST /ocr`
**Authentication:** Bearer Token required
**Headers:**
```
Authorization: Bearer your_api_key_here
Content-Type: application/json
```
**Request Body:**
```json
{
"base64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/...",
"lang": "eng"
}
```
| Parameter | Type | Required | Description |
|-----------|--------|----------|--------------------------------------------------|
| base64 | string | Yes | Base64-encoded image data |
| lang | string | No | Language code for OCR (default: "eng") |
**Response:**
```json
{
"text": ""
}
```
**Error Responses:**
- `400 Bad Request` - Missing base64 parameter
- `401 Unauthorized` - Missing or invalid authorization header
- `403 Forbidden` - Invalid API key
- `500 Internal Server Error` - OCR processing failed
## Sneak Peek 🌟
Want to try the demo? You can test the OCR API at:
**Demo Endpoint:** [https://ocr-server.novadev.my.id](https://ocr-server.novadev.my.id)
- `GET /health`
- `POST /ocr`
To get an API key, please reach out through the contact section below. I'll be happy to provide you with access!
## Let's Connect! 📞
Need to chat? Feel free to drop me a line via [Email](mailto:novaardiansyah78@gmail.com) or hit me up on [WhatsApp](https://wa.me/6289506668480?text=Hi%20Nova,%20I%20have%20a%20question%20about%20your%20project%20on%20GitHub:%20https://github.com/novaardiansyah/ocr-server). I'm just a message away, ready to groove with you! 📩
## Licensing Groove 🕺
Exciting news! This project is grooving to the rhythm of the [MIT License](LICENSE).
Feel free to use, modify, and share it with the world. Just remember to keep the original license intact. Let's spread the joy of coding together! 🚀
## Code of Conduct 🤝
We believe in fostering a welcoming and inclusive environment for everyone. Please be respectful, considerate, and constructive in all interactions. By participating in this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). Let's collaborate and make this community awesome together!
## Project Status 🚀
[](references.json)
[](LICENSE)
[](commits/main)
## Thanks to 🙏
- [Tesseract OCR](https://github.com/tesseract-ocr/tesseract) Licensed under the [Apache License 2.0](https://github.com/tesseract-ocr/tesseract?tab=Apache-2.0-1-ov-file)
---
**Happy coding and collaborating!**
— Nova Ardiansyah