kore-doc

The kore documentation found under https://docs.kore.io/
Commits | Files | Refs | README | git clone https://git.kore.io/kore-doc.git

commit 6b3b25e27efeff11d8442efa017f175ad54946ba
parent 44e514e1781e8a90f3d205a41839aecaf33d23ab
Author: Frederic Cambus <fred@statdns.com>
Date:   Sat,  5 Sep 2020 21:14:14 +0200

Fix a couple of typos in various sections.

Diffstat:
api/json.md | 2+-
api/python.md | 10+++++-----
applications/acme.md | 2+-
applications/koreconf.md | 2+-
4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/api/json.md b/api/json.md @@ -76,7 +76,7 @@ Parse the JSON data that was set via **kore_json_init**. | json | A kore\_json data structure. | ### Returns -Returns KORE\_RESULT\_OK if parsing was successfull or KORE\_RESULT\_ERROR +Returns KORE\_RESULT\_OK if parsing was successful or KORE\_RESULT\_ERROR if the parsing failed. If the parsing failed the json-\>error field holds the error code. diff --git a/api/python.md b/api/python.md @@ -18,7 +18,7 @@ A Kore Python application must be setup in the following way: * Import kore. * Define a class with a configure() method. -* Instanciate the koreapp global with that class. +* Instantiate the koreapp global with that class. The configure() method is called at startup by the Kore platform and will receive a list of arguments passed to the command-line. @@ -141,7 +141,7 @@ set via the Python code. | keymgr\_root | The root path for the keymgr process. If not set, inherited from the root option. | | acme\_runas | The user the acme process will run as. If not set, the current user. | | acme\_root | The root path for the acme process. If not set, inherited from the root option. | -| acme\_email | An email adress used for account registration. | +| acme\_email | An email address used for account registration. | | acme\_provider | A URL to the directory for an ACME provider. Defaults to Let's Encrypt. | | pledge | OpenBSD only, pledge categories for the worker processes. | | seccomp\_tracing | Linux only, seccomp violations will be logged and not cause the process to terminate. Either "yes" or "no". | @@ -261,7 +261,7 @@ The cert and key keywords should not be specified if acme is True. | --- | --- | | cert | The path to the certificate for this domain. | | key | The path to the private key for this domain. | -| acme | If true will use the configured ACME provider (let's encrypt by default) to automaticall obtain an X509 for this domain. | +| acme | If true will use the configured ACME provider (let's encrypt by default) to automatically obtain an X509 for this domain. | | client\_verify | If present points to a PEM file containing a Certificate Authority for which the client should present a certificate for. | | verify\_depth | Maximum depth for the certificate chain. | @@ -293,12 +293,12 @@ Setup a new route in the domain. The route is attached to the given | Parameter | Description | | --- | --- | -| url | URL for this route, can contain regex and capture groups. Each capture group is passed as a seperate parameter to the callback after the initial request object. | +| url | URL for this route, can contain regex and capture groups. Each capture group is passed as a separate parameter to the callback after the initial request object. | | callback | The callback to call for this route. This callback takes at least one parameter: the request object. | | Keyword | Description | | --- | --- | -| methods | A list of allowed methods. Any request to this route with an uncorrect method will automatically result in a 405. | +| methods | A list of allowed methods. Any request to this route with an incorrect method will automatically result in a 405. | | key | The path to the private key for this domain. | | methodname | For each supported method a dictionary containing parameters for the route and how they are validated. | | auth | If set should be a dictionary containing the authentication information for the route. | diff --git a/applications/acme.md b/applications/acme.md @@ -36,7 +36,7 @@ There are a few ACME related configuration options. | --- | --- | | acme\_runas | The user the acme process will run as. If not set, the current user. | | acme\_root | The root path for the acme process. If not set, inherited from the root option. | -| acme\_email | An email adress used for account registration. | +| acme\_email | An email address used for account registration. | | acme\_provider | A URL to the directory for an ACME provider. Defaults to Let's Encrypt. | The default ACME provider is "https://acme-v02.api.letsencrypt.org/directory". diff --git a/applications/koreconf.md b/applications/koreconf.md @@ -57,7 +57,7 @@ There are more options than what is listed below, specifically for validators, a | keymgr\_root | The root path for the keymgr process. If not set, inherited from the root option. | | acme\_runas | The user the acme process will run as. If not set, the current user. | | acme\_root | The root path for the acme process. If not set, inherited from the root option. | -| acme\_email | An email adress used for account registration. | +| acme\_email | An email address used for account registration. | | acme\_provider | A URL to the directory for an ACME provider. Defaults to Let's Encrypt. | | pledge | OpenBSD only, pledge categories for the worker processes. | | seccomp\_tracing | Linux only, seccomp violations will be logged and not cause the process to terminate. Either "yes" or "no". |