Skip to content

Commit 0af15de

Browse files
committed
chore: fix typo
1 parent c4df3f1 commit 0af15de

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Run the following command:
2121
$ go install github.com/ncarlier/webhookd@latest
2222
```
2323

24-
**Or** download the binary regarding your architecture:
24+
**Or** download the binary for your architecture:
2525

2626
```bash
2727
$ sudo curl -s https://raw.githubusercontent.com/ncarlier/webhookd/master/install.sh | bash
@@ -46,7 +46,7 @@ $ docker run -d --name=webhookd \
4646
Finally, it is possible to install Webhookd using the Debian packaging system through this [custom repository](https://packages.azlux.fr/).
4747

4848
> Note: Custom configuration variables can be set into `/etc/webhookd.env` file.
49-
> Sytemd service is already set and enable, you just have to start it with `systemctl start webhookd`.
49+
> Systemd service is already set and enabled, you just have to start it with `systemctl start webhookd`.
5050
5151
## Configuration
5252

@@ -85,13 +85,13 @@ In particular, examples of integration with Gitlab and Github.
8585

8686
### Webhook call
8787

88-
The directory structure define the webhook URL.
88+
The directory structure defines the webhook URL.
8989

9090
You can omit the script extension. If you do, webhookd will search by default for a `.sh` file.
9191
You can change the default extension using the `WHD_HOOK_DEFAULT_EXT` environment variable or `-hook-default-ext` parameter.
92-
If the script exists, the output will be send to the HTTP response.
92+
If the script exists, the output will be sent to the HTTP response.
9393

94-
Depending on the HTTP request, the HTTP response will be a HTTP `200` code with the script's output in real time (streaming), or the HTTP response will wait until the end of the script's execution and return the output (tuncated) of the script as well as an HTTP code relative to the script's output code.
94+
Depending on the HTTP request, the HTTP response will be a HTTP `200` code with the script's output in real time (streaming), or the HTTP response will wait until the end of the script's execution and return the output (truncated) of the script as well as an HTTP code relative to the script's output code.
9595

9696
The streaming protocol depends on the HTTP request:
9797

@@ -104,7 +104,7 @@ You can change the default mode using the `WHD_HOOK_DEFAULT_MODE` environment va
104104
[chunked]: https://datatracker.ietf.org/doc/html/rfc2616#section-3.6.1
105105

106106
If no streaming protocol is needed, you must set `X-Hook-Mode` HTTP header to `buffered`.
107-
The HTTP reponse will block until the script is over:
107+
The HTTP response will block until the script is over:
108108

109109
- Sends script output limited to the last 100 lines. You can modify this limit via the HTTP header `X-Hook-MaxBufferedLines`.
110110
- Convert the script exit code to HTTP code as follow:
@@ -127,7 +127,7 @@ echo "bar bar bar"
127127
exit 118
128128
```
129129

130-
Streamed output using `Server-sent events`:
130+
Streamed output using `Server-sent events`:
131131

132132
```bash
133133
$ curl -v --header "Accept: text/event-stream" -XGET http://localhost:8080/foo/bar
@@ -181,7 +181,7 @@ You have several ways to provide parameters to your webhook script:
181181
- HTTP headers are converted to script variables
182182
- Request body (depending the Media Type):
183183
- `application/x-www-form-urlencoded`: keys and values are converted to script variables
184-
- `text/*` or `application/json`: payload is transmit to the script as first parameter.
184+
- `text/*` or `application/json`: payload is transmitted to the script as first parameter.
185185

186186
> Note: Variable name follows "snakecase" naming convention.
187187
Therefore the name can be altered.
@@ -337,7 +337,7 @@ To activate basic authentication, you have to create a `htpasswd` file:
337337
$ # create passwd file the user 'api'
338338
$ htpasswd -B -c .htpasswd api
339339
```
340-
This command will ask for a password and store it in the htpawsswd file.
340+
This command will ask for a password and store it in the htpasswd file.
341341

342342
By default, the daemon will try to load the `.htpasswd` file.
343343
But you can override this behavior by specifying the location of the file:
@@ -405,7 +405,7 @@ $ webhookd --tls-enabled
405405
By default webhookd is expecting a certificate and key file (`./server.pem` and `./server.key`).
406406
You can provide your own certificate and key with `-tls-cert-file` and `-tls-key-file`.
407407

408-
Webhookd also support [ACME](https://ietf-wg-acme.github.io/acme/) protocol.
408+
Webhookd also supports [ACME](https://ietf-wg-acme.github.io/acme/) protocol.
409409
You can activate ACME by setting a fully qualified domain name:
410410

411411
```bash

0 commit comments

Comments
 (0)