{"id":44642980,"url":"https://github.com/intersystems/healthshare-sample-container-deploy","last_synced_at":"2026-02-14T19:07:06.561Z","repository":{"id":193555730,"uuid":"688514233","full_name":"intersystems/healthshare-sample-container-deploy","owner":"intersystems","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-21T16:00:39.000Z","size":38,"stargazers_count":4,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-21T17:23:04.935Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/intersystems.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-09-07T13:58:55.000Z","updated_at":"2024-12-06T14:06:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"925c6cb5-e365-424a-b685-8d1d093c3f10","html_url":"https://github.com/intersystems/healthshare-sample-container-deploy","commit_stats":null,"previous_names":["intersystems/healthshare-sample-container-deploy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/intersystems/healthshare-sample-container-deploy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersystems%2Fhealthshare-sample-container-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersystems%2Fhealthshare-sample-container-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersystems%2Fhealthshare-sample-container-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersystems%2Fhealthshare-sample-container-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/intersystems","download_url":"https://codeload.github.com/intersystems/healthshare-sample-container-deploy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intersystems%2Fhealthshare-sample-container-deploy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29452686,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T15:52:44.973Z","status":"ssl_error","status_checked_at":"2026-02-14T15:52:11.208Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-14T19:07:05.909Z","updated_at":"2026-02-14T19:07:06.556Z","avatar_url":"https://github.com/intersystems.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- omit in toc --\u003e\n# healthshare-sample-container-deploy\n\nThis repository contains sample deployment files to deploy InterSystems HealthShare (HS) applications as container stacks. Note that these are sample files intended to be used along with the [HealthShare user documentation](https://docs.intersystems.com/hs202311/csp/docbook/DocBook.UI.Page.cls).\n\n**These sample files ARE NOT intended for direct usage in production environments.**\n\nA single HealthShare application consists of a stack with two containers:\na Web Gateway container and a HealthShare instance container.\nBelow we describe the sample files provided in this repository to deploy such HealthShare applications.\n\n- [Structure](#structure)\n- [sample\\_deploy](#sample_deploy)\n  - [docker-compose and container.env](#docker-compose-and-containerenv)\n  - [web-gateway](#web-gateway)\n  - [config](#config)\n    - [hs](#hs)\n    - [iris](#iris)\n  - [data-ingestion](#data-ingestion)\n- [sample\\_configs](#sample_configs)\n\n\n## Structure\n\nThis repository is structured into two top level directories: `sample_deploy` and `sample_configs`.\n- `sample_deploy` contains the directory structure recommended to deploy an HS container stack. \nWhile the directory structure can be altered, this requires that you override variables in the environment (.env) files.\n- `sample_configs` contain example configuration files for configuring the different\ntypes of HS applications.\n\n## sample_deploy\n\nThis directory structure is as follows:\n```\n📦sample_deploy\n ┣ 📂config\n ┃ ┣ 📂hs\n ┃ ┃ ┗ 📜hs-base-config.json\n ┃ ┗ 📂iris\n ┃ ┃ ┣ 📜iris.key\n ┃ ┃ ┗ 📜merge.cpf\n ┣ 📂data-ingestion\n ┃ ┗ 📂Data\n ┣ 📂web-gateway\n ┃ ┣ 📂certificate\n ┃ ┃ ┣ 📜ssl-cert.key\n ┃ ┃ ┗ 📜ssl-cert.pem\n ┃ ┣ 📜CSP.conf\n ┃ ┗ 📜CSP.ini\n ┣ 📜container.env\n ┗ 📜docker-compose.yml\n```\n\nBelow we break down the roles of the various directories and files. For directories/\nfiles whose locations can be changed, the corresponding environment variables that \ncontrol the directory locations are also referenced. Note that the directory related \nenvironment variables are optional. If you do not specify directory-related environment\nvariable values, then you **must** use the default directory structure referenced in \nthe above image and detailed below.\n\n### docker-compose and container.env\n\nTo deploy the container stack, the following command is run:\n```bash\ndocker-compose --env-file=container.env up\n```\n\nThis command will configure a single HS application stack consisting of two containers: Web Gateway and HS instance.\n\nHowever, before this can be run, the values in `container.env` need to be populated. The file itself describes what each of the variables does and this is further fleshed out in the HS user documentation. \nIn below sections, when environment variables are referenced, they will only be referenced\nby name and their description can be looked up in one of the above referenced sources.\n\nYou will notice that the variables themselves or their corresponding defaults in the `docker-compose.yml` file point to other relative directories/files which are referenced in the next few sections.\n\n### web-gateway\n\nThis top level directory contains the files necessary to deploy an InterSystems \nWeb Gateway image which is documented in the [InterSystems Web Gateway documentation](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GCGI).\n\nIf you are already familiar with the InterSystems Web Gateway, here is a \n[sample docker-compose file](https://github.com/intersystems-community/webgateway-examples/tree/master/demo-compose) \nfor deploying an InterSystems Web Gateway.\n\n### config\n\nThis directory contains all necessary configuration related files used at container \ndeployment time.\n**NOTE:** Any files under this directory are NOT used during the active lifetime of the \ncontainer. Other storage locations are used for storing data needed during the \nlifetime of a running container.\n\nThis directory has two sub-directories:\n- `hs`: For HS-specific configuration files\n- `iris`: For InterSystems IRIS-specific configuration files\n\n#### hs\n\nThis directory MUST consist of a single JSON file named `hs-base-config.json` by default \n(can be overridden using environment variable ISC_HS_CONFIG_BASE_FILENAME).\nThis JSON file has the following keys in it:\n- (REQUIRED) network-config: basic network settings required to communicate with the HS instance.\n- (REQUIRED) feature-config: metadata used to configure a HS application namespace (Registry, Edge Gateway etc.)\n- (OPTIONAL) oauth-config: metadata used to configure local OAuth related settings (whether OAuth is enabled, additional network info etc.)\n\nEach of those keys has values which are JSON objects detailed in the next sections.\n\nEnvironment variables related to this directory: \n- `EXTERNAL_HS_CONFIG_DIRECTORY`\n- `ISC_HS_CONFIG_DIRECTORY`\n- `ISC_HS_CONFIG_BASE_FILENAME`\n\n**NOTE:** the `hs-base-config.json` file is not to be provided when deploying a \nHS backup mirror member. This is detailed in the [HS user documentation](https://docs.intersystems.com/hs202311/csp/docbook/DocBook.UI.Page.cls?KEY=HEMRR_ch_mirroring_existing_environment#HEMRR_mirroring_installing_second_failover_existing).\n\n#### iris\n\nThis directory MUST consist of at a minimum, an iris.key file for the license key \nof the corresponding HS image that is being deployed.\nIt is also recommended that a merge.cpf file be included for any startup related \nconfiguration settings. The example file provided sets the routine buffer memory \nto 300MB instead of the default which is 25% of the available device memory.\n\nEnvironment variables related to this directory: \n- `EXTERNAL_IRIS_CONFIG_DIRECTORY`\n- `ISC_CONFIG_DIRECTORY`\n- `ISC_CPF_MERGE_FILE_NAME`\n\n### data-ingestion\n\nThis directory does not exist in the sample directory structure but should be created \nas well as the `Data` sub-directory.\n\nEnvironment variables related to this directory: \n- `EXTERNAL_DATA_INGESTION_DIRECTORY`\n- `ISC_HS_DATA_INGESTION_DIRECTORY`\n\n\n## sample_configs\n\nThis directory contains sample JSON objects for each of the keys of `hs-base-config.json`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersystems%2Fhealthshare-sample-container-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintersystems%2Fhealthshare-sample-container-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersystems%2Fhealthshare-sample-container-deploy/lists"}