Skip to content

Commit b2fcdcb

Browse files
committed
Some tpyos
1 parent 7bcb87f commit b2fcdcb

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ If you are looking for a super flexible and extensible API Management suite whic
9595

9696
# Getting Started
9797

98-
* Read the [wicked box guide](doc/wicked-in-a-box.md) to try out how easy it is to deploy an API Portal and Gateway to your local machien
98+
* Read the [wicked box guide](doc/wicked-in-a-box.md) to try out how easy it is to deploy an API Portal and Gateway to your local machine
9999
* To start incorporating your own APIs, head over to the [documentation](doc/index.md), and read the how-to on [creating a portal configuration](doc/creating-a-portal-configuration.md)
100100

101101
# Related repositories

doc/deployment-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The deployment architecture is usually as follows:
88

99
![Deployment Architecture](images/deployment-architecture.png)
1010

11-
The next sections briefly describes the functionality of each deployment artifact. For a list of which docker images are begind the different boxes, please refer to the [docker images](docker-images.md) documentation.
11+
The next sections briefly describes the functionality of each deployment artifact. For a list of which docker images are in the different boxes, please refer to the [docker images](docker-images.md) documentation.
1212

1313
### Load Balancer
1414

doc/docker-images.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ There are some special environment variables which can be used to change/specify
6767
* `GIT_CREDENTIALS`: The credentials (`username:password`) to pass in to the `git clone` command at startup of the container; if this is not set, the portal API container assumes that it can access the git repository without credentials (i.e. that it's a public repository)
6868
* `GIT_BRANCH`: The branch to check out/clone at startup of the portal API container. If this is not set/is empty, `master` is assumed.
6969
* `DEBUG`: The specification of debug message sources to be output. Use `portal-api:*` to output debug messages from the portal API itself. Use `*` to output **all** debug messages of all packages used in the portal API. Note that this can become **very** verbose (up to such an extent that it may have impact on performance). To see specific debug messages, inspect the source code of the `portal-api` to see which debug scopes are available (`require('debug')('portal-api:asdfg')`). Please also note that secrets and credentials (including passwords of users) MAY be exposed in the logs when specifying a very verbose debug logging. **So take care with the logs**.
70+
* `LOG_LEVEL`: Specify the debug message log level using this environment variable. Use either `debug` to get **all** debug messages, or one of `info`, `warn` and `error`. Defaults to `info`.
7071

7172
**Note**: Currently, regardless of the branch selected with `GIT_BRANCH`, the `HEAD` is checked out. In the next versions, `GIT_REVISION` may be introduced to support cloning a specific version of the git repository.
7273

@@ -77,7 +78,7 @@ There are some special environment variables which can be used to change/specify
7778
These four core components can only be impacted using two different environment variables:
7879

7980
* `PORTAL_API_URL`: Pass in the URL of the `api` API in case this is not the standard `http://portal-api:3001` URL. If this environment variable is empty, this is what is going to be tested. In case you are deploying using `docker-compose`, this is usually the correct address, and also when deploying using e.g. Kubernetes, there will be a service which is discoverable using this DNS address, so this will be correct in most cases. In case it's not, use this variable to bootstrap the configuration process. When using the [Kubernetes Helm chart](../wicked/README.md), the services are named slightly different, also depending on the helm deployment name, but if you use the predefined `k8s` environment in the static configuration, things should "just work".
80-
* `LOG_LEVLE`: Specify the debug message log level using this environment variable. Use either `debug` to get **all** debug messages.
81+
* `LOG_LEVEL`: Specify the debug message log level using this environment variable. Use either `debug` to get **all** debug messages, or one of `info`, `warn` and `error`. Defaults to `info`.
8182

8283
### `kong`
8384

0 commit comments

Comments
 (0)