Skip to content

Commit

Permalink
Update README.md (#98)
Browse files Browse the repository at this point in the history
* Update README.md

Added:
- instructions to run the image from DockerHub
- config info

* Fix typos in README.md

---------

Co-authored-by: MaximPlusov <[email protected]>
  • Loading branch information
bdoubrov and MaximPlusov committed Aug 30, 2023
1 parent fd29d3d commit bfa4c1f
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,17 @@ following are most used and may prove informative if you are reading the code:
A good place to get going is the [Dropwizard getting started guide](https://www.dropwizard.io/en/stable/getting-started.html).
The [Dropwizard core documentation](https://www.dropwizard.io/en/stable/manual/core.html) covers the features used in the code base.

Building and running
Running DockerHub image
--------------------

To run the veraPDF rest image from DockerHub:
```
docker run -d -p 8080:8080 -p 8081:8081 verapdf/rest:latest
```

Port 8080 serves both the veraPDF web interface and the veraPDF Rest API. Port 8081 serves the DropWizard diagnostics.

Building and running locally
--------------------

### Docker
Expand Down Expand Up @@ -63,7 +73,7 @@ There's an "official" docker image that can be grabbed by `docker pull verapdf/r
Currently it's delivered as a single Maven module, veraPDF-rest.

### Want to try?
First clone this project, got to the project directory and then build the Maven project:
First clone this project, go to the project directory and then build the Maven project:

git clone https://github.com/veraPDF/veraPDF-rest.git
cd veraPDF-rest
Expand Down Expand Up @@ -164,3 +174,6 @@ no client application or page, but curl can be used:
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"

### 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 bfa4c1f

Please sign in to comment.