> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/internal-developer-portal/use-idp/plugins/available-plugins/firehydrant.md).

# FireHydrant plugin

| Plugin details |                                                                                                               |
| -------------- | ------------------------------------------------------------------------------------------------------------- |
| **Created by** | [FireHydrant](https://firehydrant.com/)                                                                       |
| **Category**   | Incident management                                                                                           |
| **Source**     | [GitHub](https://github.com/backstage/community-plugins/tree/main/workspaces/firehydrant/plugins/firehydrant) |
| **Type**       | Open-source plugin                                                                                            |

### Configuration <a href="#configuration" id="configuration"></a>

#### Application configuration YAML <a href="#application-configuration-yaml" id="application-configuration-yaml"></a>

*No action required*

This plugin requires a backend proxy configuration to make calls to FireHydrant with authentication. The following configuration is set by default and you do not need to change anything:

```yaml
proxy:
  "/firehydrant/api":
    target: "https://api.firehydrant.io/v1/"
    pathRewrite:
      "api/proxy/firehydrant/api/?": "/"
    changeOrigin: true
    headers:
      Authorization: Bearer ${FIREHYDRANT_TOKEN}
```

#### Secrets <a href="#secrets" id="secrets"></a>

Since the `FIREHYDRANT_TOKEN` variable is used in the application configuration, you must generate a FireHydrant API token and set it as the value of `FIREHYDRANT_TOKEN`. You can do this in your [FireHydrant app](https://app.firehydrant.io/organizations/bots).

#### Delegate proxy <a href="#delegate-proxy" id="delegate-proxy"></a>

*No action required*

This plugin does not require a delegate proxy to be set up because FireHydrant is publicly accessible.

### Layout <a href="#layout" id="layout"></a>

This plugin exports a UI card that you can show on the **Overview** tab of a service or on any other layout page. Go to **Configure** → **Layout**, choose **Service** in the dropdown menu, and then add the following YAML code in the **Overview** section:

```yaml
- component: FirehydrantCard
```

![](/files/SBWamgn2tnSkFAMNOSGa)

### Annotations <a href="#annotations" id="annotations"></a>

To further configure the plugin for a service in the software catalog, set the following annotation in its `catalog-info.yaml` definition file:

```yaml
metadata:
  annotations:
    firehydrant.com/service-name: <firehydrant-service-name>
```

### Support <a href="#support" id="support"></a>

The plugin is owned by FireHydrant and managed in the [Backstage repository](https://github.com/backstage/community-plugins/tree/main/workspaces/firehydrant/plugins/firehydrant) as an open-source project. Create a GitHub issue to report bugs or suggest new features for the plugin.
