https://github.com/smark91/terraform-cloud-discord-webhook-proxy
This is a Golang application that listens for Terraform Cloud webhooks and sends formatted messages to a Discord webhook based on the webhook payload.
https://github.com/smark91/terraform-cloud-discord-webhook-proxy
Last synced: 6 months ago
JSON representation
This is a Golang application that listens for Terraform Cloud webhooks and sends formatted messages to a Discord webhook based on the webhook payload.
- Host: GitHub
- URL: https://github.com/smark91/terraform-cloud-discord-webhook-proxy
- Owner: smark91
- License: gpl-3.0
- Created: 2023-04-19T22:46:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-21T16:25:45.000Z (over 2 years ago)
- Last Synced: 2024-04-22T10:04:50.658Z (over 2 years ago)
- Language: Go
- Size: 190 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraform Cloud Discord Webhook Proxy
Made using ChatGPT conversation (included this `README.md`) :heart:
This is a Golang application that listens for Terraform Cloud webhooks and sends formatted messages to a Discord webhook based on the webhook payload.
## Prerequisites
- [Terraform Cloud](https://app.terraform.io/) account
- [Discord](https://discord.com/) account
- [Golang](https://golang.org/) installed on your local machine or server
- [Docker](https://www.docker.com/) installed on your local machine or server (optional)
- [Docker Compose](https://docs.docker.com/compose/) installed on your local machine or server (optional)
## Setup
1. Create a Discord webhook for your server or channel. Follow the instructions in [this guide](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to create a webhook URL.
2. Set the `TF_DISCORD_PROXY_WEBHOOK_URL` environment variable to the Discord webhook URL:
```bash
export TF_DISCORD_PROXY_WEBHOOK_URL=
```
3. (Optional) Set the `TF_DISCORD_PROXY_PORT` environment variable to the desired port number (default is `8080`):
```bash
export TF_DISCORD_PROXY_PORT=
```
4. (Optional) Set the `TF_DISCORD_PROXY_AUTH_TOKEN` environment variable to the Terraform Cloud webhook auth token:
```bash
export TF_DISCORD_PROXY_AUTH_TOKEN=
```
5. Build and run the Golang application:
```bash
go run main.go
```
or
```bash
docker run -p $TF_DISCORD_PROXY_PORT:8080 -e TF_DISCORD_PROXY_WEBHOOK_URL=$TF_DISCORD_PROXY_WEBHOOK_URL -e TF_DISCORD_PROXY_AUTH_TOKEN=$TF_DISCORD_PROXY_AUTH_TOKEN smark91/terraform-cloud-discord-webhook:
```
6. In your Terraform Cloud workspace, create a notification configuration with the following settings:
- **Name:** Discord Webhook
- **Trigger:** All events
- **URL:** `/webhook` (replace `` with the URL of your server where the Docker container is running)
- **Token:** `` (optional, replace `` with a secret webhook auth token)
7. Create a new run in your Terraform Cloud workspace to trigger the webhook.
## Using Docker Compose
If you prefer to use Docker Compose to run the Terraform Cloud Discord webhook proxy, follow these steps:
1. Create a Discord webhook for your server or channel. Follow the instructions in [this guide](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to create a webhook URL.
2. Create a file named `docker-compose.yml` with the following contents:
```yaml
version: '3'
services:
terraform-cloud-discord-webhook-proxy:
image: smark91/terraform-cloud-discord-webhook-proxy:
ports:
- "8080:8080"
environment:
- TF_DISCORD_PROXY_WEBHOOK_URL=
# - TF_DISCORD_PROXY_PORT=8080
# - TF_DISCORD_PROXY_AUTH_TOKEN=
```
Replace `` with the Discord webhook URL, and `` with the Terraform Cloud webhook auth token (if you specified one).
3. Run the following command to start the Docker Compose stack:
```bash
docker-compose up -d
```