|
1 | | -# Convoy |
| 1 | + |
| 2 | + |
| 3 | +[https://getconvoy.io](https://getconvoy.io) |
| 4 | + |
2 | 5 | Convoy is a fast & secure webhooks service. It receives event data from a HTTP API and sends these event data to the configured endpoints. To get started download the [openapi spec](https://github.com/frain-dev/convoy/blob/main/openapi.yaml) into Postman or Insomnia. |
3 | 6 |
|
4 | | -Installation |
5 | | ------------------ |
| 7 | +## Installation |
| 8 | + |
6 | 9 | You can either download the docker image or compile from source |
7 | 10 |
|
| 11 | +##### Docker |
8 | 12 |
|
9 | | -##### Docker |
10 | 13 | ```bash |
11 | 14 | docker pull ghcr.io/frain-dev/convoy:v0.1.0 |
12 | 15 | ``` |
13 | 16 |
|
14 | 17 | ##### Compile from source |
| 18 | + |
15 | 19 | ```bash |
16 | 20 | git clone https://github.com/frain-dev/convoy.git |
17 | 21 | cd convoy |
18 | 22 | go build -o convoy ./cmd |
19 | 23 | ``` |
20 | 24 |
|
21 | | -Concepts |
22 | | ------------------ |
| 25 | +## Concepts |
| 26 | + |
23 | 27 | 1. **Apps:** An app is an abstraction representing a user who wants to receive webhooks. Currently, an app contains one endpoint to receive webhooks. |
24 | 28 | 2. **Events:** An event represents a webhook event to be sent to an app. |
25 | 29 | 3. **Delivery Attempts:** A delivery attempt represents an attempt to send an event to it's respective app's endpoint. It contains the `event body`, `status code` and `response body` received on attempt. The amount of attempts on a failed delivery depends on your configured retry strategy. |
26 | 30 |
|
| 31 | +## Configuration |
| 32 | + |
| 33 | +Convoy is configured using a json file with a sample configuration below: |
27 | 34 |
|
28 | | -Configuration |
29 | | ------------------ |
30 | | -Convoy is configured using a json file with a sample configuration below: |
31 | 35 | ```json |
32 | 36 | { |
33 | | - "database": { |
34 | | - "dsn": "mongo-url-with-username-and-password" |
35 | | - }, |
36 | | - "queue": { |
37 | | - "type": "redis", |
38 | | - "redis": { |
39 | | - "dsn": "redis-url-with-username-and-password" |
40 | | - } |
41 | | - }, |
42 | | - "server": { |
43 | | - "http": { |
44 | | - "port": 5005 |
45 | | - } |
46 | | - }, |
47 | | - "auth": { |
48 | | - "type": "none", |
49 | | - }, |
50 | | - "strategy": { |
51 | | - "type": "default", |
52 | | - "default": { |
53 | | - "intervalSeconds": 125, |
54 | | - "retryLimit": 15 |
55 | | - } |
56 | | - }, |
57 | | - "signature": { |
58 | | - "header": "X-Company-Event-Webhook-Signature" |
59 | | - } |
| 37 | + "database": { |
| 38 | + "dsn": "mongo-url-with-username-and-password" |
| 39 | + }, |
| 40 | + "queue": { |
| 41 | + "type": "redis", |
| 42 | + "redis": { |
| 43 | + "dsn": "redis-url-with-username-and-password" |
| 44 | + } |
| 45 | + }, |
| 46 | + "server": { |
| 47 | + "http": { |
| 48 | + "port": 5005 |
| 49 | + } |
| 50 | + }, |
| 51 | + "auth": { |
| 52 | + "type": "none" |
| 53 | + }, |
| 54 | + "strategy": { |
| 55 | + "type": "default", |
| 56 | + "default": { |
| 57 | + "intervalSeconds": 125, |
| 58 | + "retryLimit": 15 |
| 59 | + } |
| 60 | + }, |
| 61 | + "signature": { |
| 62 | + "header": "X-Company-Event-Webhook-Signature" |
| 63 | + } |
60 | 64 | } |
61 | 65 | ``` |
| 66 | + |
62 | 67 | #### Notes to Configuration |
63 | | -- You can set basic auth mechanism with the following: |
| 68 | + |
| 69 | +- You can set basic auth mechanism with the following: |
| 70 | + |
64 | 71 | ```json |
65 | 72 | { |
66 | | - "auth": { |
67 | | - "type": "basic", |
68 | | - "basic" : { |
69 | | - "username": "username", |
70 | | - "password": "password" |
71 | | - } |
72 | | - } |
| 73 | + "auth": { |
| 74 | + "type": "basic", |
| 75 | + "basic": { |
| 76 | + "username": "username", |
| 77 | + "password": "password" |
| 78 | + } |
| 79 | + } |
73 | 80 | } |
74 | 81 | ``` |
0 commit comments