diff options
| author | ekhudiyev <88712424+ekhudiyev@users.noreply.github.com> | 2021-12-13 12:07:55 +0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-13 12:07:55 +0400 |
| commit | e81786f258dd91ecd5fa6094c356752bc9183ccf (patch) | |
| tree | bc002d5f8e36a3d9d5bd6bacb54ce4a39a1a99e2 /docs/configuration/service/https.rst | |
| parent | 48ac071fe099c40d79849bedc01d2b1bcefc7bad (diff) | |
| parent | 1ed197bb772bde1b783f73171a130ff265a86793 (diff) | |
| download | vyos-documentation-e81786f258dd91ecd5fa6094c356752bc9183ccf.tar.gz vyos-documentation-e81786f258dd91ecd5fa6094c356752bc9183ccf.zip | |
Merge branch 'vyos:equuleus' into equuleus
Diffstat (limited to 'docs/configuration/service/https.rst')
| -rw-r--r-- | docs/configuration/service/https.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/configuration/service/https.rst b/docs/configuration/service/https.rst index 1f1e2aa9..0c6dcbd9 100644 --- a/docs/configuration/service/https.rst +++ b/docs/configuration/service/https.rst @@ -4,7 +4,7 @@ HTTP-API ######## -VyOS provide a HTTP API. You can use it to execute op-mode commands, +VyOS provides an HTTP API. You can use it to execute op-mode commands, update VyOS, set or delete config. Please take a look at the :ref:`vyosapi` page for an detailed how-to. @@ -15,7 +15,7 @@ Configuration .. cfgcmd:: set service https api keys id <name> key <apikey> - Set an named api key, every key have the same, full permissions + Set a named api key, every key has the same, full permissions on the system. .. cfgcmd:: set service https api debug @@ -25,7 +25,7 @@ Configuration .. cfgcmd:: set service https api port - Set the listen port of the local API, this have non effect of the + Set the listen port of the local API, this has no effect on the webserver. The default is port 8080 .. cfgcmd:: set service https api strict @@ -46,7 +46,7 @@ Configuration .. cfgcmd:: set service https api-restrict virtual-host <vhost> - Nginx exposes the local API on all virtual servers, by default + Nginx exposes the local API on all virtual servers, by default. Use this to restrict nginx to one or more virtual hosts. .. cfgcmd:: set service https certificates certbot domain-name <text> @@ -71,14 +71,15 @@ Configuration Example Configuration ********************* -Set an API-KEY is the minimal configuration to get a working API Endpoint. +Setting an API-KEY is the minimal configuration needed to get a working API +Endpoint. .. code-block:: none set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY -To use this full configuration we asume a publice accessable hostname. +To use this full configuration we asume a globally resolvable hostname. .. code-block:: none @@ -88,4 +89,4 @@ To use this full configuration we asume a publice accessable hostname. set service https virtual-host rtr01 listen-address 198.51.100.2 set service https virtual-host rtr01 listen-port 11443 set service https virtual-host rtr01 server-name rtr01.example.com - set service https api-restrict virtual-host rtr01.example.com
\ No newline at end of file + set service https api-restrict virtual-host rtr01.example.com |