summaryrefslogtreecommitdiff
path: root/docs/components
diff options
context:
space:
mode:
authorMatthieu <matthieu@developershouse.xyz>2021-09-17 18:41:56 +0400
committerMatthieu <matthieu@developershouse.xyz>2021-09-17 18:41:56 +0400
commit469a8fb1ea7b689399c30badbf33fc467531c561 (patch)
tree8ea3caf86cc00c8c3b37287b6a7b1774bb5e8895 /docs/components
parentba0170ea15d6ebc1c9049f02adabd1ee4df6de64 (diff)
basic com implementation & cache base
Diffstat (limited to 'docs/components')
-rw-r--r--docs/components/auto-scaler.md0
-rw-r--r--docs/components/cache.md0
-rw-r--r--docs/components/gateway.md0
-rw-r--r--docs/components/ratelimiter.md0
-rw-r--r--docs/components/webhook.md8
5 files changed, 8 insertions, 0 deletions
diff --git a/docs/components/auto-scaler.md b/docs/components/auto-scaler.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/components/auto-scaler.md
diff --git a/docs/components/cache.md b/docs/components/cache.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/components/cache.md
diff --git a/docs/components/gateway.md b/docs/components/gateway.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/components/gateway.md
diff --git a/docs/components/ratelimiter.md b/docs/components/ratelimiter.md
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/components/ratelimiter.md
diff --git a/docs/components/webhook.md b/docs/components/webhook.md
new file mode 100644
index 0000000..76361ef
--- /dev/null
+++ b/docs/components/webhook.md
@@ -0,0 +1,8 @@
+# Webhook
+
+> TD;TR The webhook component is an implementation of the discord interaction webhooks; You can either use the Gateway or the Webhooks. The webhooks __require__ an external https endpoint to work.
+
+The webhook source code is located in the [webhook](../../webhook) folder and is implemented in Rust. It's a simple http web server which implements the webhook signature verification and deserialization. Like the gateway, the messages are redirected using the [relaying system](../common#relaying_trait).
+
+The signature verification is done using libsodium via the libsodium-sys trait.
+Subsequently, it uses code marked as "unsafe" in rust. It's built into the binary statically. Any route can be used to receive webhook messages. \ No newline at end of file