Skip to content

Commit

Permalink
Add information to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EkaterinaKomar committed Sep 14, 2023
1 parent 1a8c3e6 commit e7f5484
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,5 +175,23 @@ or to obtain the result in XML:

curl -F "file=@veraPDF-corpus/PDF_A-1b/6.1 File structure/6.1.12 Implementation limits/veraPDF test suite 6-1-12-t01-fail-a.pdf" localhost:8080/api/validate/1b -H "Accept:application/xml"

Validation pdf by url is available as a POST service at `http://localhost:8080/api/validate/url/*id*`. To test with curl:

```
curl -F "url=http://www.pdf995.com/samples/pdf.pdf" localhost:8080/api/validate/url/1b
```

To validate your local files you need to add folder with files to the docker container:

```
docker cp /path/of/the/folder <Container_ID>:/home
```

and use curl:

```
curl -F "url=file:///home/folder/pdf.pdf" localhost:8080/api/validate/url/1b
```

### Configuration files
Configuration parameters are located in `/opt/verapdf-rest/config` folder of the container file system. The details on the parameters are available at https://docs.verapdf.org/cli/config/

0 comments on commit e7f5484

Please sign in to comment.