From c07574d99b4e1c8412cc172130afe92abf66fe18 Mon Sep 17 00:00:00 2001 From: Mark G Date: Fri, 8 Mar 2024 12:09:56 -0500 Subject: [PATCH] Improve main doc --- docs/index.md | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/docs/index.md b/docs/index.md index 5cdd11a..176b5ba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 - -### 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 +} +``` \ No newline at end of file