> For the complete documentation index, see [llms.txt](https://jembi.gitbook.io/openhim-platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jembi.gitbook.io/openhim-platform/packages/reverse-proxy-traefik.md).

# Reverse Proxy Traefik

## Reverse Proxy Traefik

## Reverse Proxy Traefik

The package is an alternative reverse proxy Nginx, this reverse proxy exposes packages using both subdomains and subdirectories to host the following services:

| Package  | Hosted                                                                                 |
| -------- | -------------------------------------------------------------------------------------- |
| Superset | Sub Domain (e.g. superset.)                                                            |
| Jempi    | Sub Domain (e.g. jempi.)                                                               |
| Santempi | Sub Domain (e.g. santempi.)                                                            |
| Kibana   | Sub Domain (e.g. kibana.)                                                              |
| Minio    | Sub Directory (e.g. /minio)                                                            |
| Grafana  | Sub Directory (e.g. /grafana)                                                          |
| JSReport | Sub Directory (e.g. /jsreport)                                                         |
| OpenHim  | Sub Domain (Frontend) Sub Directory (Backend) (e.g. openhim. and openhim./openhimcore) |

> Please ensure that the ENV "DOMAIN\_NAME\_HOST\_TRAEFIK" is set, in this documentation we will be using the placeholder "domain" for its value

### Subdomain-Based Reverse Proxy

The following packages do not support subdomains and require the use of domain/subdomain to access over the reverse proxy

#### Superset

Set the following environment variable in the package-metadata.json in the "./dashboard-visualiser-superset" directory

```bash
"environmentVariables":
{
# Other Configurations
...
    "SUPERSET_TRAEFIK_SUBDOMAIN": "superset"
}
```

#### Jempi

Set the following environment variables in the package-metadata.json in the "./client-registry-jempi" directory

```bash
"environmentVariables":
{
# Other Configurations
...
    "REACT_APP_JEMPI_BASE_API_HOST": "jempi-api.domain",
    "REACT_APP_JEMPI_BASE_API_PORT": "443",
    "JEMPI_API_TRAEFIK_SUBDOMAIN": "jempi-api",
    "JEMPI_WEB_TRAEFIK_HOST_NAME": "jempi-web",
}
```

#### Santempi

Set the following environment variables in the package-metadata.json in the "./client-registry-santempi" directory

```bash
"environmentVariables":
{
# Other Configurations
...
    "SANTEDB_WWW_TRAEFIK_SUBDOMAIN": "santewww",
    "SANTEDB_MPI_TRAEFIK_SUBDOMAIN": "santempi"
}
```

#### Enabling Kibana

Set the following environment variables in the package-metadata.json in the "./dashboard-visualiser-kibana" directory

```bash

"environmentVariables":
{
# Other Configurations
...
    "KIBANA_TRAEFIK_SUBDOMAIN": "kibana"
}

```

### Subdirectory

#### Enabling Minio

Set the following environment variables in the package-metadata.json in the "monitoring" directory

```bash
"environmentVariables":
{
# Other Configurations
...
    "MINIO_BROWSER_REDIRECT_URL": "https://domain/minio-console/"
}
```

#### MinIO Configuration

The MinIO server is configured to run with the following port settings:

* **API Port**: 9090
* **Console Port**: 9001

Ensure that your Traefik configuration reflects these ports to properly route traffic to the MinIO services. The API can be accessed at `https://<domain>/minio` and the Console at `https://<domain>/minio-console`.

Update your Traefik labels in the `docker-compose.yml` to match these settings:

```yaml
# API Configuration
- traefik.http.services.minio.loadbalancer.server.port=9090
# Console Configuration
- traefik.http.services.minio-console.loadbalancer.server.port=9001
```

#### Enabling Grafana

Set the following environment variables in the package-metadata.json in the "monitoring" directory

```bash

"environmentVariables":
{
# Other Configurations
...
    "KC_GRAFANA_ROOT_URL": "%(protocol)s://%(domain)s/grafana/",
    "GF_SERVER_DOMAIN": "domain",
    "GF_SERVER_SERVE_FROM_SUB_PATH": "true",
}

```

#### JS Report

Set the following environment variables in the package-metadata.json in the "dashboard-visualiser-jsreport" directory

```bash
"environmentVariables":
{
# Other Configurations
...
    "JS_REPORT_PATH_PREFIX": "/jsreport"
}
```

#### OpenHIM

Set the following environment variables in the package-metadata.json in the "./interoperability-layer-openhim" directory

> Note: Only the Backend services are accessible through subdirectory paths, not the frontend

```bash
"environmentVariables":
{
# Other Configurations
...
    "OPENHIM_SUBDOMAIN": "domain",
    "OPENHIM_CONSOLE_BASE_URL": "http://domain"
    "OPENHIM_CORE_MEDIATOR_HOSTNAME": "domain/openhimcomms",
    "OPENHIM_MEDIATOR_API_PORT": "443"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://jembi.gitbook.io/openhim-platform/packages/reverse-proxy-traefik.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.