Skip to content
This repository has been archived by the owner on Apr 25, 2023. It is now read-only.

Add documentation for inline file conversion #200

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,13 @@ docker run --rm -v %cd%:/converted/ arachnysdocker/athenapdf athenapdf http://bl

1. `docker pull arachnysdocker/athenapdf-service`
2. `docker run -p 8080:8080 --rm arachnysdocker/athenapdf-service`
3. Inline conversion: `http://<docker-address>:8080/convert?auth=arachnys-weaver&url=http://blog.arachnys.com/`
4. OR cURL, and redirect output to file: `curl http://dockerhost:8080/convert\?auth\=arachnys-weaver\&url\=http://blog.arachnys.com/ |> out.pdf`
3. Conversion:
1. URL conversion: `http://<docker-address>:8080/convert?auth=arachnys-weaver&url=http://blog.arachnys.com/` OR cURL, and redirect output to file: `curl http://dockerhost:8080/convert\?auth\=arachnys-weaver\&url\=http://blog.arachnys.com/ |> out.pdf`
2. Inline conversion:
* send a POST request to the convert endpoint (`http://<docker-address>:8080/convert?auth=arachnys-weaver&ext=html`)
* the body should be in multipart/form-data MIME type
* the only field in this form should have the name `file` with the `filename` option set
* field value should be the plain HTML. All resources used in the HTML must be either inlined or accessible by the athenapdf container without any authentication
5. See [`weaver`][weaver] for full documentation

The default authentication key is `arachnys-weaver`. This can be changed through the `WEAVER_AUTH_KEY` environment variable.
Expand Down