Commit a115c7e8 authored by Jure's avatar Jure

docs(job-xsweet): add usage docs

parent f3441b05
# XSweet job component
WARNING: This is an early version, please test and report any issues.
This is a component that uses PubSweet's internal job queue to provide XSweet conversions to PubSweet applications.
# Usage
Once specified in your app's components config by adding '@pubsweet/job-xsweet' adds:
## A `/convertDocxToHTML` endpoint
That takes a `docx` file formdata input, with e.g. something like a
```
curl -X POST \
'http://localhost:3000/convertDocxToHTML?=' \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F docx=@/Users/juretriglav/src/pdk-tesms/pubsweet/packages/components/job-xsweet/src/test.docx
```
This publishes a job that the job runner (a Docker container) picks up.
## Docker container
Run it with: `docker run pubsweet/job-xsweet:latest -e DATABASE_URL=yourdatabaseurl` (e.g. postgres://username:password@host.docker.internal:5432/yourdb)
The DATABASE_URL is needed so that the Docker container knows how to connect to your database.
After the Docker container starts up, jobs from the endpoint will start to be processed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment