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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
merlinschumacher authored Nov 25, 2021
1 parent f9513f0 commit 4b6f136
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ The easiest way to run OCCV is to use a container. An up to date docker image is

To start the container you need a recent version of Docker and `docker-compose`. Just execute `docker-compose up` and the server will answer on port 8000 of your server. Modify the compose file to fit your needs. Currently only validation against the [German list of certificates](https://github.com/Digitaler-Impfnachweis/certification-apis) provided by Ubirch and the [Austrian list of certificates](https://github.com/Federal-Ministry-of-Health-AT/green-pass-overview#details-on-trust-listsbusiness-rulesvalue-sets) is supported. But this should be able to validate all certificates issued in the EU. The certificates are updated every 24 hours.

To start the container just with `docker` run:

```
docker run -p 8000:8000 -e CERT_COUNTRY=DE ghcr.io/merlinschumacher/open-covid-certificate-validator:main
```


If you want to start the service manually, you need to set up a virtual envinroment and install the package requirements. Then set the environment variable `CERT_COUNTRY`to either `DE` or `AT` and run `python main.py`. After the service starts it should run on `http://localhost:8000`.

To access the API send a POST request containing the following JSON to `/`:
Expand Down

0 comments on commit 4b6f136

Please sign in to comment.