Skip to content

Commit

Permalink
chore: move Asynchronous PDF Export section to Advanced configuration (
Browse files Browse the repository at this point in the history
  • Loading branch information
grigoriev authored Sep 2, 2024
1 parent a26d5d6 commit 3fc86d4
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,6 @@ To change WeasyPrint Service URL, adjust the following property in the `polarion
ch.sbb.polarion.extension.pdf-exporter.weasyprint.service=http://localhost:9080
```

### Asynchronous PDF Export: export jobs timeout
This extension provides REST API to export PDF asynchronously. Using this API, it is possible to start export job, observe their status and get result.
Finished (succeed or failed) and in-progress export jobs will be preserved in memory until configured timeout. To change this timeout, adjust the following property in the local `pdf-converter-jobs.properties` file:
```properties
# Timeout in minutes to keep finished async conversion jobs results in memory
jobs.timeout.finished.minutes=30
# Timeout in minutes to wait until async conversion jobs is finished
jobs.timeout.in-progress.minutes=60
```

### PDF exporter extension to appear on a Document's properties pane

1. Open a project where you wish PDF Exporter to be available
Expand Down Expand Up @@ -196,6 +186,18 @@ ch.sbb.polarion.extension.pdf-exporter.internalizeExternalCss=true
## REST API
This extension provides REST API. OpenAPI Specification can be obtained [here](docs/openapi.json).

## Advanced Configuration

### Asynchronous PDF Export: export jobs timeout
This extension provides REST API to export PDF asynchronously. Using this API, it is possible to start export job, observe their status and get result.
Finished (succeed or failed) and in-progress export jobs will be preserved in memory until configured timeout. To change this timeout, adjust the following property in the local `pdf-converter-jobs.properties` file:
```properties
# Timeout in minutes to keep finished async conversion jobs results in memory
jobs.timeout.finished.minutes=30
# Timeout in minutes to wait until async conversion jobs is finished
jobs.timeout.in-progress.minutes=60
```

## Known issues

All good so far.
Expand Down

0 comments on commit 3fc86d4

Please sign in to comment.