From bfa4c1feb2680d514d4874282f77918cbb6c3b96 Mon Sep 17 00:00:00 2001 From: Boris Doubrov Date: Wed, 30 Aug 2023 11:52:09 +0300 Subject: [PATCH] Update README.md (#98) * Update README.md Added: - instructions to run the image from DockerHub - config info * Fix typos in README.md --------- Co-authored-by: MaximPlusov --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b95099d..17199724 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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/