Skip to content

Commit

Permalink
Update fhir-web deployment documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
peterMuriuki committed Nov 20, 2023
1 parent dc119df commit 3630c02
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/fhir-web-docker-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ We use different technologies to deploy fhir-web. This documentation will focus

- A basic knowledge of containerization technologies with focus on Docker.
- A well configured [keycloak server](https://hub.docker.com/r/onaio/keycloak) deployment.
- We currently support version `18.0.0-legacy`
- This should include the Keycloak [Realm](https://www.keycloak.org/docs/latest/server_admin/#configuring-realms) and [Client](https://www.keycloak.org/docs/latest/server_admin/#assembly-managing-clients_server_administration_guide) configurations.
- Read more about the expected keycloak configuration [here](./keycloak-configuration.md)
- A well configured [Hapi FHIR server](https://github.com/opensrp/hapi-fhir-jpaserver-starter) deployment.

## Background
Expand Down Expand Up @@ -109,6 +109,8 @@ We use different technologies to deploy fhir-web. This documentation will focus
# content security policy configuration
# remove optional-sentry-base-url config block if your deployment has no sentry
- 'EXPRESS_CONTENT_SECURITY_POLICY_CONFIG={"connect-src":["''self''","<optional-sentry-base-url>","<keycloak-base-url>","<fhir-server-base-url>"],"default-src":["''self''"],"img-src":["''self''","https://github.com/opensrp/","https://*.githubusercontent.com/opensrp/"]}'
# to disable CSP
# - 'EXPRESS_CONTENT_SECURITY_POLICY_CONFIG=false'

# optional sentry config
# - 'EXPRESS_RESPONSE_HEADERS={"report-to":", {endpoints:[{url:https://<optional-sentry-base-url>/api/<optional-sentry-projectId>/security/?sentry_key=<optional-sentry-key>\\u0026sentry_environment=<optional-sentry-environment>\\u0026sentry_release=<optional-sentry-release-name>}],group:csp-endpoint,max_age:10886400}"}'
Expand All @@ -123,6 +125,7 @@ We use different technologies to deploy fhir-web. This documentation will focus
window._env_ = {
// keycloak
REACT_APP_AUTHZ_STRATEGY: 'keycloak',
REACT_APP_KEYCLOAK_API_BASE_URL: '<keycloak-base-url>/auth/admin/realms/<keycloak-realm>',
REACT_APP_KEYCLOAK_LOGOUT_URL:
'<keycloak-base-url>/auth/realms/<keycloak-realm>/protocol/openid-connect/logout',
Expand Down Expand Up @@ -158,6 +161,13 @@ We use different technologies to deploy fhir-web. This documentation will focus
REACT_APP_ENABLE_FHIR_USER_MANAGEMENT: 'false',
REACT_APP_ENABLE_FHIR_COMMODITY: 'false',
REACT_APP_ENABLE_QUEST: 'false',
REACT_APP_ENABLE_TEAMS_ASSIGNMENT_MODULE: 'false',
// i18n
REACT_APP_SUPPORTED_LANGUAGES: "en,fr",
REACT_APP_ENABLE_LANGUAGE_SWITCHER: 'false',
REACT_APP_PROJECT_CODE: 'core',
REACT_APP_LANGUAGE_CODE: 'en'
// optional overrides
SKIP_PREFLIGHT_CHECK: 'true',
Expand All @@ -173,8 +183,6 @@ We use different technologies to deploy fhir-web. This documentation will focus
REACT_APP_PROJECT_CODE: 'demo',
REACT_APP_DEFAULTS_TABLE_PAGE_SIZE: '10',
REACT_APP_OPENSRP_LOGOUT_URL: 'null',
REACT_APP_OPENSRP_ROLES:
'{"USERS":"ROLE_EDIT_KEYCLOAK_USERS","LOCATIONS":"ROLE_VIEW_KEYCLOAK_USERS","TEAMS":"ROLE_VIEW_KEYCLOAK_USERS","CARE_TEAM":"ROLE_VIEW_KEYCLOAK_USERS","QUEST":"ROLE_VIEW_KEYCLOAK_USERS","HEALTHCARE_SERVICE":"ROLE_VIEW_KEYCLOAK_USERS","GROUP":"ROLE_VIEW_KEYCLOAK_USERS","COMMODITY":"ROLE_VIEW_KEYCLOAK_USERS",}',
REACT_APP_PRACTITIONER_TO_ORG_ASSIGNMENT_STRATEGY: 'ONE_TO_MANY',
// optional sentry config
Expand Down
Empty file added docs/keycloak-configuration.md
Empty file.

0 comments on commit 3630c02

Please sign in to comment.