Skip to content

Commit 9d8def8

Browse files
committed
add experimental support for docker compose
1 parent f9ed636 commit 9d8def8

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,24 @@ Here's an example where we process a set of PDFs contained in the `foo` director
139139
docker run -it --rm --network=host -v foo:/input -v bar:/output scholarvista-app process-pdfs
140140
```
141141

142+
### Docker Compose (Experimental)
143+
144+
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:
145+
146+
#### SH-Shell like
147+
148+
```bash
149+
INPUT_DIR=/path/to/input/dir OUTPUT_DIR=/path/to/output/dir COMMAND='process-pdfs' docker-compose up
150+
```
151+
152+
#### PowerShell
153+
154+
```powershell
155+
$env:INPUT_DIR="/path/to/input/dir"; $env:OUTPUT_DIR="/path/to/output/dir"; $env:COMMAND="process-pdfs" docker-compose up
156+
```
157+
158+
_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._
159+
142160
## License
143161

144162
Please refer to the `LICENSE` file.
File renamed without changes.

docs/usage.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,22 @@ Here's an example where we process a set of PDFs contained in the `foo` director
119119
```bash
120120
docker run -it --rm --network=host -v foo:/input -v bar:/output scholarvista-app process-pdfs
121121
```
122+
123+
## Docker Compose (Experimental)
124+
125+
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:
126+
127+
### SH-Shell like
128+
129+
```bash
130+
INPUT_DIR=/path/to/input/dir OUTPUT_DIR=/path/to/output/dir COMMAND='process-pdfs' docker-compose up
131+
```
132+
133+
### PowerShell
134+
135+
```powershell
136+
$env:INPUT_DIR="/path/to/input/dir"; $env:OUTPUT_DIR="/path/to/output/dir"; $env:COMMAND="process-pdfs" docker-compose up
137+
```
138+
139+
_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._
140+

0 commit comments

Comments
 (0)