Browse Source

docs: Update README with detailed configuration information and volume management setup

main
Mam Thenebo 8 months ago
parent
commit
1b87d348cf
  1. 22
      README.md

22
README.md

@ -49,6 +49,24 @@ tail -f ./logs/*
This command tails the log files, offering a live view into the application’s operational logs.
## Additional Configuration
## Configuration Details
The application uses environment variables for additional configurations, such as the Tesseract data prefix, which can be adjusted in the `docker-compose.yml` file to suit your setup needs.
### Environment Variables
The application uses several environment variables to configure its behavior:
- `FLASK_ENV`: Sets the environment for the Flask application. In this case, `development` for enabling debug features.
- `FLASK_APP`: Points to the entry file of the Flask application. Here, it's set to `app.py`.
- `TESSDATA_PREFIX`: Specifies the directory where the Tesseract OCR data is stored, which is crucial for OCR functionality.
### Port Configuration
The Docker container is configured to expose the Flask application on port `4000` of the host machine, mapping it to port 5000 inside the container. This mapping is defined in the `docker-compose.yml` file, allowing the application to be accessible via `http://localhost:4000`.
### Volume Management
- **Uploads Folder**: The `./uploads` folder on the host is mapped to `/app/uploads` inside the Docker container. This is where uploaded PDF files are stored temporarily during processing.
- **Outputs Folder**: Similarly, the `./outputs` folder on the host is mapped to `/app/outputs` inside the container. This folder stores the converted Word documents, making them accessible outside the container.
- **Logs Folder**: The `./logs` folder is used to store log files generated by the application, providing insights into its operations and any errors.
This setup ensures that data persists across container restarts and is easily accessible for both inputs and outputs.
Loading…
Cancel
Save