Skip to content

Commit

Permalink
Improve main doc
Browse files Browse the repository at this point in the history
  • Loading branch information
blinktag committed Mar 8, 2024
1 parent 7a35f11 commit c07574d
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,39 @@ description: |-
---

# streamdal Provider
# Streamdal Provider

[![logo](https://github.com/streamdal/streamdal/raw/main/assets/img/streamdal-logo-light.png#gh-light-mode-only)]

[![Discord](https://img.shields.io/badge/Community-Discord-4c57e8.svg)](https://discord.gg/streamdal)

This provider is used to interact with the [Streamdal server API](https://github.com/streamdal/streamdal)


<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- **address** (String) The address of the Streamdal server.
- **connection_timeout** (Number) The connection timeout for the Plumber server.
- **token** (String) Streamdal Server API token
## Provider Schema

| variable | type | description | envar |
|:---|:-------|:----------------------------------------------|:---|
| address | string | The address of your Streamdal server install. | `STREAMDAL_ADDRESS` |
| connection_timeout | int | gRPC connection attempt timeout in seconds. | `STREAMDAL_CONNECTION_TIMEOUT` |
| token | string | API Auth Token | `STREAMDAL_TOKEN` |

## Example Provider Setup

```hcl
terraform {
required_providers {
streamdal = {
source = "streamdal/streamdal"
version = "0.1.1"
}
}
}
provider "streamdal" {
token = "1234"
address = "localhost:8082"
connection_timeout = 10
}
```

0 comments on commit c07574d

Please sign in to comment.