add experimental support for docker compose

mciccale · Mar 6, 2024 · 9d8def8 · 9d8def8
1 parent f9ed636
commit 9d8def8
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -139,6 +139,24 @@ Here's an example where we process a set of PDFs contained in the `foo` director
 docker run -it --rm --network=host -v foo:/input -v bar:/output scholarvista-app process-pdfs
 ```
 
+### Docker Compose (Experimental)
+
+You can try to run **ScholarVista** through **Docker Compose**. However, this feature is still in development and may not work as expected. **ScholarVista** will be trying to connect to **Grobid** before it has started, and it will be restarted until the **Grobid** service is up and running. You can try it by:
+
+#### SH-Shell like
+
+```bash
+INPUT_DIR=/path/to/input/dir OUTPUT_DIR=/path/to/output/dir COMMAND='process-pdfs' docker-compose up
+```
+
+#### PowerShell
+
+```powershell
+$env:INPUT_DIR="/path/to/input/dir"; $env:OUTPUT_DIR="/path/to/output/dir"; $env:COMMAND="process-pdfs" docker-compose up
+```
+
+_Note: The **COMMAND** variable can be either `process-pdfs` or `process-xmls`. And the directories are the host machine directories where the files are extracted and left, respectively._
+
 ## License
 
 Please refer to the `LICENSE` file.

diff --git a/compose.yaml → docker-compose.yml b/compose.yaml → docker-compose.yml
diff --git a/docs/usage.md b/docs/usage.md
@@ -119,3 +119,22 @@ Here's an example where we process a set of PDFs contained in the `foo` director
 ```bash
 docker run -it --rm --network=host -v foo:/input -v bar:/output scholarvista-app process-pdfs
 ```
+
+## Docker Compose (Experimental)
+
+You can try to run **ScholarVista** through **Docker Compose**. However, this feature is still in development and may not work as expected. **ScholarVista** will be trying to connect to **Grobid** before it has started, and it will be restarted until the **Grobid** service is up and running. You can try it by:
+
+### SH-Shell like
+
+```bash
+INPUT_DIR=/path/to/input/dir OUTPUT_DIR=/path/to/output/dir COMMAND='process-pdfs' docker-compose up
+```
+
+### PowerShell
+
+```powershell
+$env:INPUT_DIR="/path/to/input/dir"; $env:OUTPUT_DIR="/path/to/output/dir"; $env:COMMAND="process-pdfs" docker-compose up
+```
+
+_Note: The **COMMAND** variable can be either `process-pdfs` or `process-xmls`. And the directories are the host machine directories where the files are extracted and left, respectively._
+