36908-vm/readme.txt
2025-12-13 11:06:47 +00:00

45 lines
1.7 KiB
Plaintext

How to get your API keys:
**1. OCR (Tesseract)**
Tesseract is a free, open-source OCR engine. You don't need an API key in the traditional sense, but you do need to install it on your server.
- **On Debian/Ubuntu:**
`sudo apt update`
`sudo apt install tesseract-ocr`
`sudo apt install tesseract-ocr-heb` (for Hebrew language support)
- **On CentOS/RHEL:**
`sudo yum install tesseract`
(You may need to find a repository that has the Hebrew language pack)
No API key needs to be set in the environment variables for Tesseract. The application will call it from the command line.
**2. AI Service (Free Tier or Mock)**
For the MVP, we are using a free or mock AI service. There are several options for free language models. One option is to use a free tier from a provider. Another is to set up a local model if you have the hardware.
For a simple mock setup, you can have the application return a pre-defined JSON response without calling a real AI.
If you choose a service that provides an API key, you will need to set it in your `.env` file:
`AI_API_KEY="your_key_here"`
**3. Email Provider (Free SMTP)**
You can use a service like Mailgun or SendGrid which offer free tiers for a limited number of emails per month.
- **Sign up for a free account** on a provider like Mailgun.
- **Verify your domain.** This is a necessary step to be able to send emails.
- **Get your SMTP credentials.** They will look something like this:
- Host: `smtp.mailgun.org`
- Port: `587`
- Username: `postmaster@yourdomain.com`
- Password: `a_long_secret_password`
- **Set these credentials in your `.env` file:**
`SMTP_HOST="smtp.mailgun.org"`
`SMTP_PORT="587"`
`SMTP_USER="your_username"`
`SMTP_PASS="your_password"`
`MAIL_FROM="you@yourdomain.com"`