conwetlab/ngsi-proxy

Proxy allowing receiving notifications from Orion Context Broker on browser environments

ngsi-proxy's Issues

Usage Documentation

NGSI-Proxy Usage Documentation

• Create eventsource:

  curl -X POST {{ngsiproxyurl}}/eventsource
  

  Sample create eventsource response:

  { 
   "connection_id":"353529a0-281a-11ec-b25b-6d62e91d5158",
   "url":"{{ngsiproxyurl}}/eventsource/353529a0-281a-11ec-b25b-6d62e91d5158"
  }
  

• Create callback:

  Use the previously generated connection_id to create the
  callback:

  curl -X POST '{{ngsiproxyurl}}/callbacks' \
  --data-raw '{
              "connection_id": "353529a0-281a-11ec-b25b-6d62e91d5158"
  }'
  

  Sample create callback response:

  {
   "callback_id":"40b18800-281a-11ec-b25b-6d62e91d5158",
   "url":"{{ngsiproxyurl}}/callbacks/40b18800-281a-11ec-b25b-6d62e91d5158"
  }
  

• Consume callback:

  The callback to be notified by the context-broker through a
  subscription. Use the previously generated callback_id to create
  the callback:

  curl -X POST '{{ngsiproxyurl}}/callbacks/40b18800-281a-11ec-b25b-6d62e91d5158' \
  --data-raw '{
   	    "keyofpayloadcontent": "valueofpayloadcontent"
  }'
  

• Sample EventSource:

  Use the url returned in "Create eventsource"

  const sse = new EventSource('{{ngsiproxyurl}}/eventsource/353529a0-281a-11ec-b25b-6d62e91d5158');
  sse.addEventListener("notification", function(e) {
    console.log(JSON.parse(e.data));
  }) 
  

  This EventSource will fire everytime the callback is consumed.

Improve documentation - API use without wirecloud

I would love to know how could it be used without Wirecloud, just as a proxy between Orion Context Broker and our custom react app.

How do we manage the Orion subscription from the proxy?

Thanks

Provide a welcome web page for people accessing the ngsi-proxy using a web browser

Useful for people testing if the ngsi-proxy is up and running. Also useful for people accessing the proxy by error.

This welcome page should point to the documentation about how to use it.

ngsiproxy not running

I have just installed the latest ngsiproxy using this command:
docker run --name beincpps-ngsiproxy -d fiware/ngsiproxy
The docker container is running properly: docker container ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
9c5ade363d3f fiware/ngsiproxy "/bin/sh -c ngsi-p..." 11 minutes ago Up 11 minutes 3000/tcp beincpps-ngsiproxy

But when trying to access in firefox the address http://localhost:3000 , the ngsiproxy is not responding and the page is not accessible.

Do you have any idea?

Thanks!

Configuration for NGSI proxy

 I have installed the latest ngsiproxy on docker container.I am not able to receive notifications from context broker in wirecloud widget though subscription is created successfully.
Is there a need of additional configuration than issuing
docker run --name some-ngsiproxy -p 3000:3000 -d fiware/ngsiproxy ?

Add HTTPS documentation

Add documentation about how to configure the NGSI proxy to be served using HTTPS.

Docker image

Provide a docker image

Support Cross-Origin Resource Sharing (CORS)

Current implementation has partial support for Cross-Origin Resource Sharing.