You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-65Lines changed: 2 additions & 65 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,71 +26,6 @@ Hooks is a RESTful webhook server framework written in Ruby. It is designed to b
26
26
27
27
Hooks is designed to be very easy to setup and use. It provides a simple DSL for defining webhook endpoints and then you can use plugins to handle the incoming requests and optionally authenticate them.
28
28
29
-
### Architecture Flow
30
-
31
-
The following Mermaid diagram shows the complete request processing flow, including server bootstrap, plugin loading, and webhook request handling:
Here is a very high-level overview of how Hooks works:
95
30
96
31
1. You define a global configuration file (e.g. `hooks.yml`) where you can specify where your webhook endpoint configs are located, and the directory where your plugins are located. Here is an example of a minimal configuration file:
@@ -205,6 +140,8 @@ Congratulations! You have successfully set up a basic Hooks server which will li
205
140
206
141
Keep reading to learn how to customize your Hooks server with different plugins for handlers, authentication, and more.
207
142
143
+
For an in-depth flow diagram of how the Hooks server processes incoming requests, see the [Architecture Flow](docs/architecture_flow.md) documentation.
144
+
208
145
### Advanced
209
146
210
147
This section will go into a more advanced and detailed example of how to setup a Hooks server with custom plugins, authentication, and more. This section also assumes you already have the `hooks-ruby` gem installed via a bundler Gemfile as shown in the [Installation](#installation-) section above.
0 commit comments