diff --git a/README.md b/README.md
index 981023ecb..1a79c2018 100644
--- a/README.md
+++ b/README.md
@@ -146,44 +146,20 @@ login: demo | password: demodemodemo
Apart from the GUI, Konga also exposes an API providing helpful methods for
integrating your services and applications with Kong
-### Exposing the API
+#### Exposing the API
-There are some steps you need to take before exposing Konga's API.
-All steps can be easily done form the GUI.
+In /backend/local.js
set the attribute expose_api
to true
-#### Step 1
+When the backend is lifted again, Konga will register it's API to Kong, create a consumer and associate that consumer to an apikey.
-The first thing you need to do is create a Kong API to use as a Gateway to Konga.
-
-**Example API configuration:**
-
-
-name : konga -config.request_path : /kongapi -config.strip_request_path : true -config.preserve_host : true // We need this set to true so that Konga can validate that the request is coming from Kong -config.upstream_url : http://konga-host-url/api -- -#### Step 2 - -Add a ***Key Authentication*** plugin to the created API. - -#### Step 3 - -Create a consumer and associate it with an API key credential. This api key will be used to authenticate the requests made to Konga's API. - -#### Step 4 - -Finally , you need to configure the kong_proxy_hosts property in
/backend/local.js
.
+Additionally , you need to configure the whitelist_hosts
attribute in /backend/local.js
.
These are the hosts from which Konga will accept API requests.
-For a local Kong installation this property would be:
+
+By default, Konga will only accept API requests from 127.0.0.1
-kong_proxy_hosts : ['127.0.0.1:8000'], +whitelist_hosts : ["127.0.0.1"]-Konga will now accept API requests originated from
127.0.0.1:8000
-> In a production environment, where Konga resides in the same server as Kong, it would be safer to block incoming traffic to the port Konga's backend is lifted as well.
### API Methods
@@ -197,21 +173,21 @@ All requests made to Konga's API require some custom headers.
api-key-name
(required)apiKey
(required)key_names
you specified when assigning the Key Authentication plugin to the API.konga-node-id
(optional)kong-admin-url
(optional)kong_admin_url
specified in /backend
configuration.POST
-> $ curl -X POST http://kong:8000/{your-api-request-path}/consumers
+> $ curl -X POST http://kong:8000/konga/consumers
This method allows you to create a consumer while associating it with groups and authorizations all at once.
@@ -276,7 +252,7 @@ This method allows you to create a consumer while associating it with groups and
#### Register API POST
-> $ curl -X POST http://kong:8000/{your-api-request-path}/apis
+> $ curl -X POST http://kong:8000/konga/apis
This method allows you to register an API to Kong while adding required plugins to it as well.
@@ -349,6 +325,7 @@ This method allows you to register an API to Kong while adding required plugins
* Complete tests
* Add more consumer import adapters (?)
* Write a detailed Wiki
+* Move API to it's own module so that it is lifted on a different port (?)
## Author
Panagis Tselentis