hlnconsulting/ice repository overview

Introduction

Information about ICE is available on the ICE Wiki⁠, and instructions for interacting with the ICE service are in the ICE Client Implementation Guide⁠.

Latest news about ICE is at https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/23920670/News⁠

See Installing ICE⁠ for instructions on installing the ICE service using either the prepackaged distribution⁠ or this docker image⁠.

See Building ICE from Source Code⁠ if you wish to build ICE from source.

If you are interested in receiving periodic e-mails pertinent to ICE, you may either subscribe to join the ICE Announcements E-mail List⁠ or contact us at [email protected]⁠ and we can add your e-mail address to the list for you. We send e-mail to this list only when there is important information to share about new releases or relevant to the operation of ICE. This is a low-volume list and we do not share group members' e-mail addresses with anyone.

If you have any questions, comments or suggestions, please e-mail us at [email protected]⁠. For information about commercial support options available through HLN Consulting, please see https://www.hln.com/services/open-source/ice/ice-services⁠.

Installing and Running the ICE Service Using Docker

1. Download the latest docker image:

% docker pull hlnconsulting/ice:latest

1. Start the service:

% docker run --log-opt max-size=100m --log-opt max-file=5 --rm -d -p 32775:8080 --name ice hlnconsulting/ice:latest

This will make the ICE service available on host port 32775, and set the log options to reasonable values. See the docker-run command documentation for options.

If you wish to set ICE to a different timezone, you can set the container environment variable TZ equal to your desired timezone (e.g. - America/New_York), as follows:

% docker run -e TZ=America/New_York --log-opt max-size=100m --log-opt max-file=5 --rm -d -p 32775:8080 --name ice hlnconsulting/ice:latest

You can test the ICE service by running the scripts found under: https://github.com/cdsframework/ice/tree/master/curl-rest-tests⁠

To View Logs While the Service is Running

% docker logs -f ice

To Shut Down the ICE Service

% docker stop ice

Configuration:

The following environment variables (with their defaults) are supported:

• TZ="UTC"
• ICE_OUTPUT_EARLIEST_AND_OVERDUE_DATES="Y"
• ICE_ENABLE_DOSE_OVERRIDE_FEATURE="N"
• ICE_OUTPUT_SUPPLEMENTAL_TEXT="Y"
• ICE_ENABLE_UNSUPPORTED_VACCINE_GROUP="N"
• ICE_VACCINE_GROUP_EXCLUSIONS="ANTHRAX,MOSQUITO_BORNE,CHOLERA,JAPANESE_ENCEPHALITIS,TYPHOID,YELLOW_FEVER"
• ICE_DISABLE_COVID19_SEP2023_DOSE_NUMBER_RESET="N"
• ICE_FIRE_LIMIT="25000"

These variables may be overridden at run time by specifying a different value for the environment variable.