wtzbzdev/cvrdecode repository overview

CVRDecode, when run as a docker image, will create a web server whose 'welcome' page contains a form asking the user to download a ZIP file. This ZIP file is expected to contain images that include the QR codes that are used in California digital vaccine records, and/or smart health card URIs, each in a file whose extension is ".shc". The URIs start with the string "shc://", followed by a long list of digits that encode the records. After the ZIP file is provided, a button can be pressed to generate a table in CSV (Comma Separated Value) format. Browsers will typically give a user a choice of saving this file or opening it with some application, typically a spreadsheet.

To run, use the command

 docker run --publish 80:80 --detach --name cvrdecode wtzbzdev/cvrdecode:1.4

This will start a web server based on the Java jdk.httpserver module, which will provide a single web page containing the form described above. The web server can be controlled with five environment variables, each set with a 'docker run' --env option:

• --env BACKLOG=M where M is a positive integer will set the TCP backlog.
• --env NTHREADS=M where M is a positive integer will set the number of threads the server can use.
• --env TRACE=TRUE will turn on tracing with output directed to standard output.
• --env IPADDR=ADDR will set the IP address of the server to ADDR. The value "wildcard" is replaced in the wildcard address and the value "loopback" indicates the IP address of the loopback device. This variable is used in version 1.2 and later.
• --env PORT=TCP_PORT (where TCP_PORT is the server's TCP_PORT) explicitly sets the TCP port (the default is port 80). Some cloud services require that the same port number be used inside and outside a container, and in this case, the PORT environment variable might have to be changed.

To access the web page, use the URL http://localhost:/⁠ if docker was started as shown, and localhost should be replaced with the actual host name when run remotely. If the port is not 80, the port should appear after the host name, separated from it by a colon. The image wtzbzdev/cvrdecode uses HTTP, not HTTPS. When HTTPS is needed (e.g., when running on a public network), one can configure a reverse proxy.

A typical use case for this container is a private party restricted to vaccinated individuals. A common practice for such events is for participants to email images of their vaccination records and a list will be checked at the door, and wtzbzdev/cvrdecode can generate such a list quickly with the entries sorted by name and date of birth. Each row in the list will contain the last vaccination date, whether or not a person is fully vaccinated, and whether or not the record's digital signature is valid.