build: Update Helm chart and k8s guide to work with latest Outpost version (#255)

* chore: Rename eventkit -> outpost

* build: Update Helm chart and k8s guide to work with latest Outpost version

* docs: Update k8s guide cleanup step

* docs: Update k8s guide on minikube tunnel

* chore(docs): helm readme review

* chore(docs): move k8s example into examples + add as quickstart

* chore(docs): Rabbit MQ -> RabbitMQ

* chore(examples): move helm chart back under "deployments" (#267)

* feat: add migration guide and example migration script (#260)

* feat(docs): migration guide

* feat(examples): TypeScript migration example

* chore(examples): update migration example

* chore(examples): update migration examples

* chore(docs): API doc formatting. One correct.

* chore(docs): Update migration guide

* chore(docs): add pgsql schema info

* chore: update example config files

* chore: add YAML config

* chore(docs): update Zudoku

* chore(docs): hard-code YAML example for now

* fix: Typo

* fix: Change Outpost config schema full path

---------

Co-authored-by: Alex Luong <alex@alexluong.com>

---------

Co-authored-by: Phil Leggetter <phil@leggetter.co.uk>

Author: alexluong

.env.example

@@ -34,15 +34,15 @@ DELIVERYMQ_MAX_CONCURRENCY=1
 TOPICS="user.created,user.updated,user.deleted" # comma separated list of topics to subscribe to, replace with your own topics
 
 # Webhook Destination
-# DESTINATION_WEBHOOK_HEADER_PREFIX="x-outpost-"
-# DESTINATION_WEBHOOK_DISABLE_DEFAULT_EVENT_ID_HEADER=false
-# DESTINATION_WEBHOOK_DISABLE_DEFAULT_SIGNATURE_HEADER=false
-# DESTINATION_WEBHOOK_DISABLE_DEFAULT_TIMESTAMP_HEADER=false
-# DESTINATION_WEBHOOK_DISABLE_DEFAULT_TOPIC_HEADER=false
-# DESTINATION_WEBHOOK_SIGNATURE_CONTENT_TEMPLATE={{.Timestamp.Unix}}.{{.Body}}
-# DESTINATION_WEBHOOK_SIGNATURE_HEADER_TEMPLATE=t={{.Timestamp.Unix}},v0={{.Signatures | join ","}}
-# DESTINATION_WEBHOOK_SIGNATURE_ENCODING="hex"
-# DESTINATION_WEBHOOK_SIGNATURE_ALGORITHM="hmac-sha256"
+# DESTINATIONS_WEBHOOK_HEADER_PREFIX="x-outpost-"
+# DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_EVENT_ID_HEADER=false
+# DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_SIGNATURE_HEADER=false
+# DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_TIMESTAMP_HEADER=false
+# DESTINATIONS_WEBHOOK_DISABLE_DEFAULT_TOPIC_HEADER=false
+# DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATE={{.Timestamp.Unix}}.{{.Body}}
+# DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATE=t={{.Timestamp.Unix}},v0={{.Signatures | join ","}}
+# DESTINATIONS_WEBHOOK_SIGNATURE_ENCODING="hex"
+# DESTINATIONS_WEBHOOK_SIGNATURE_ALGORITHM="hmac-sha256"
 
 # DISABLE_TELEMETRY=true
 

.outpost.yaml.example

@@ -85,6 +85,14 @@ destinations:
   metadata_path: "config/outpost/destinations" # Path to destination metadata
   webhook:
     header_prefix: "x-custom-" # Prefix for webhook headers
+    # disable_default_event_id_header
+    # disable_default_signature_header
+    # disable_default_timestamp_header
+    # disable_default_topic_header
+    # signature_content_template: {{.Timestamp.Unix}}.{{.Body}}
+    # signature_header_template: t={{.Timestamp.Unix}},v0={{.Signatures | join ","}}
+    # signature_encoding: hex
+    # signature_algorithm: hmac-sha256
 
 # Note: OpenTelemetry Configuration
 # It is recommended to configure OpenTelemetry using environment variables as they are better supported by the SDK.

README.md

@@ -59,7 +59,9 @@ Outpost is a self-hosted and open-source infrastructure that enables event produ
 
 ## Quickstart
 
-Clone the repo:
+Ensure you have [Docker](https://docs.docker.com/engine/install/) installed.
+
+Clone the Outpost repo:
 
 ```sh
 git clone https://github.com/hookdeck/outpost.git
@@ -102,7 +104,6 @@ Create a tenant with the following command, replacing `<TENANT_ID>` with a uniqu
 
 ```sh
 curl --location --request PUT 'localhost:3333/api/v1/<TENANT_ID>' \
---header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>'
 ```
 
@@ -146,7 +147,7 @@ Check the logs on your server or your webhook capture tool for the delivered eve
 
 ## Documentation
 
-- [Get Started](https://outpost.hookdeck.com/docs/quickstart)
+- [Get Started](https://outpost.hookdeck.com/docs/quickstarts)
 - [Overview](https://outpost.hookdeck.com/docs/overview)
 - [Features](https://outpost.hookdeck.com/docs/features)
 - [Guides](https://outpost.hookdeck.com/docs/guides/deployment)