Installing OMEGAMON Data Requester on Linux (amd64)

You must install OMEGAMON Data Requester to analyze and visualize data gathered from OMEGAMON monitoring agents.

Before you begin

Complete the tasks provided in the Prerequisites section. See Prerequisites for installing OMEGAMON Web UI.
You must ensure that the user on the platform where Grafana is installed has read access to the OMEGAMON Data Requester files and directories.

Procedure

Go to the directory where you extracted the content of the OMEGAMON_WEB_UI_2.1.0.tar.gz file.
Run the following command to extract the content of OMEGAMON Data Requester:
```
tar -xvf OMEGAMON_Data_Requester_2.1.0.tar.gz
```
Run the following command to extract the content of OMEGAMON starter dashboards:
```
tar -xvf OMEGAMON_Dashboard_2.1.0_2025-11-14.tar.gz
```
Run the following command to create the volume if it is not created:
```
docker volume create omegamon-grafana-volume
```
Note: The volume name is defined as omegamon-grafana-volume in the command. You can modify this name to suit your preferences.

Run the following command to create the container:

docker run -d -p <host-port>:3000 \
--name=<grafana_container_name> \
--user "$(id -u)" \
--volume "omegamon-grafana-volume:/var/lib/grafana" \
--volume "<path_to_omegamon_data_req>:/var/lib/grafana/plugins/rocketsoftware-omegamon-app" \
--volume "<path_to_provisioning_dashboards_config_file>:/etc/grafana/provisioning/dashboards/dashboards.yaml" \
--volume "<path_to_provisioning_dashboards>:/etc/dashboards" \
--env "GF_AUTH_GENERIC_OAUTH_ENABLED=true" \
--env "GF_AUTH_GENERIC_OAUTH_AUTH_URL=https://<sso_provider_address>/realms/<realm_name>/protocol/openid-connect/auth" \
--env "GF_AUTH_GENERIC_OAUTH_TOKEN_URL=https://<sso_provider_address>/realms/<realm_name>/protocol/openid-connect/token" \
--env "GF_AUTH_GENERIC_OAUTH_API_URL=https://<sso_provider_address>/realms/<realm_name>/openid-connect/userinfo" \
--env "GF_AUTH_GENERIC_OAUTH_TLS_SKIP_VERIFY_INSECURE=true" \
--env "GF_AUTH_GENERIC_OAUTH_AUTO_LOGIN=true" \
--env "GF_AUTH_GENERIC_OAUTH_SKIP_ORG_ROLE_SYNC=true" \
--env "GF_AUTH_GENERIC_OAUTH_ALLOW_SIGN_UP=true" \
--env "GF_AUTH_GENERIC_OAUTH_CLIENT_ID=<grafana_clien_id>" \
--env "GF_AUTH_GENERIC_OAUTH_CLIENT_SECRET=<grafana_client_secret>" \
--env "GF_AUTH_GENERIC_OAUTH_SCOPES=openid offline_access" \
--env "GF_AUTH_GENERIC_OAUTH_EMAIL_ATTRIBUTE_PATH=email" \
--env "GF_AUTH_GENERIC_OAUTH_LOGIN_ATTRIBUTE_PATH=username" \
--env "GF_AUTH_GENERIC_OAUTH_NAME_ATTRIBUTE_PATH=username" \
--env "GF_USERS_AUTO_ASSIGN_ORG_ROLE=Admin" \
--env "GF_AUTH_GENERIC_OAUTH_USE_PKCE=true" \
--env "GF_AUTH_GENERIC_OAUTH_USE_REFRESH_TOKEN=true" \
--network=<network_name> \
--restart unless-stopped  \
grafana/grafana-oss:12.1.0

Table 1. Variables that you must replace with actual values in the command
Variables	Description
`<host-port>`	Port number on the host to access Grafana UI. For example, `3000`
`<grafana_container_name>`	Logical name of the Grafana container. You can specify a name to suit your preferences. For example, `omegamon_data_req`
`<path_to_omegamon_data_req>`	Path where you extracted the OMEGAMON Data Requester content. For example, `/opt/omwebui/rocketsoftware-omegamon-app`
`<path_to_provisioning_dashboards_config_file>`	Path to the `omegamon-dashboards-config.yaml` file. For example, `/opt/omwebui/omegamon-dashboards/omegamon-dashboards-config.yaml`
`<path_to_provisioning_dashboards>`	Path to the OMEGAMON starter dashboards. For example, `/opt/omwebui/omegamon-dashboards`
`<network_name>`	Name of the Docker bridge network that you created during the installation of OMEGAMON Gateway. This is necessary because it allows the Grafana container with OMEGAMON Data Requester to run within the same network as the OMEGAMON Gateway container. For example, `omegamon_network`
`12.1.0`	The version number of the Grafana Open Source image.

Environment Variable	Description	Value
`GF_AUTH_GENERIC_OAUTH_ENABLED`	Enables Generic OAuth authentication.	`true`
`GF_AUTH_GENERIC_OAUTH_AUTH_URL`	Authorization endpoint of Keycloak.	https://`<sso_provider_address>`/realms/`<realm_name>`/protocol/openid-connect/auth
`GF_AUTH_GENERIC_OAUTH_TOKEN_URL`	Endpoint used to obtain the Keycloak access token.	https://`<sso_provider_address>`/realms/`<realm_name>`/protocol/openid-connect/token
`GF_AUTH_GENERIC_OAUTH_API_URL`	Endpoint used to obtain user information compatible with Keycloak.	https://`<sso_provider_address>`/realms/`<realm_name>`/protocol/openid-connect/userinfo
`GF_AUTH_GENERIC_OAUTH_AUTO_LOGIN`	Enables users to bypass the login screen and automatically log in.	`true`
`GF_AUTH_GENERIC_OAUTH_SKIP_ORG_ROLE_SYNC`	Stops automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually.	`true`
`GF_AUTH_GENERIC_OAUTH_ALLOW_SIGN_UP`	Controls Grafana user creation through the Keycloak login.	`true`
`GF_AUTH_GENERIC_OAUTH_CLIENT_ID`	Client ID that you define for Grafana in Keycloak.	`grafana_clien_id`
`GF_AUTH_GENERIC_OAUTH_CLIENT_SECRET`	Client secret that you define for Grafana in Keycloak.	`grafana_clien_secret`
`GF_AUTH_GENERIC_OAUTH_SCOPES`	List of comma or space separated Keycloak scopes for Grafana.	openid email profile offline_access roles
`GF_AUTH_GENERIC_OAUTH_EMAIL_ATTRIBUTE_PATH`	User email lookup from the user information.	email
`GF_AUTH_GENERIC_OAUTH_LOGIN_ATTRIBUTE_PATH`	User login lookup from the user ID token.	username
`GF_AUTH_GENERIC_OAUTH_NAME_ATTRIBUTE_PATH`	User name lookup from the user ID token.	username
`GF_AUTH_GENERIC_OAUTH_USE_PKCE`	Enables PKCE verification flow for improved security.	`true`
`GF_AUTH_GENERIC_OAUTH_USE_REFRESH_TOKEN`	Enables to use refresh token and check access token expiration.	`true`
`GF_AUTH_GENERIC_OAUTH_TLS_SKIP_VERIFY_INSECURE`	Enables the client to accept any certificate presented by the server and any hostname in that certificate.	`true`
`GF_USERS_AUTO_ASSIGN_ORG_ROLE`	Determines the default role assigned to new users. You can set this to one of the following roles: (Viewer (default), Admin, Editor, and None).	`Admin`

Run the following command to confirm the container is running:
```
docker ps
```
Additionally, if you need to check the container logs for any errors or messages, you can do so by running the following command:
```
docker logs <container_name>
```
Verify the installation of OMEGAMON Data Requester by logging in to the Grafana user interface.

Results

You have installed OMEGAMON Data Requester.

What to do next

You can perform the following tasks:

Add a datasource in Grafana to fetch OMEGAMON agents' data. See Adding data sources .
Upgrade starter dashboards to receive the latest fixes and improvements. See Upgrading starter dashboards.