Skip to content

Commit a6ba15f

Browse files
committed
Update copyrights.
1 parent 891bbb9 commit a6ba15f

File tree

4 files changed

+59
-19
lines changed

4 files changed

+59
-19
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,4 +190,4 @@ Full instructions can be found within the [documentation](https://ngsi-ld-tutori
190190

191191
## License
192192

193-
[MIT](LICENSE) © 2020-2025 FIWARE Foundation e.V.
193+
[MIT](LICENSE) © 2020-2026 FIWARE Foundation e.V.

app/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ All Keys and Secrets must be passed in using Environment variables. The followin
101101

102102
## License
103103

104-
MIT © 2020-2025 FIWARE Foundation e.V.
104+
MIT © 2020-2026 FIWARE Foundation e.V.
105105

106106
See the LICENSE file in the root of this project for license details.
107107

forwarder/README.md

Lines changed: 50 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,57 @@
66
[![NGSI LD](https://img.shields.io/badge/NGSI-LD-d6604d.svg)](https://cim.etsi.org/NGSI-LD/official/front-page.html)
77
[![JSON LD](https://img.shields.io/badge/JSON--LD-1.1-f06f38.svg)](https://w3c.github.io/json-ld-syntax/)
88

9-
Simple nodejs express application for use with the FIWARE Step-by-Step tutorials. This component can be used to proxy and amend requests.
9+
Simple nodejs express application for use with the FIWARE Step-by-Step tutorials. This is a **Context Provider** that can
10+
be used to proxy and amend requests to a Context Broker.
1011

11-
This application provides various sources of context and demonstrates various aspects of FIWARE To run the application
12-
in debug mode add `DEBUG=broker:*`
12+
This application provides various sources of context and demonstrates various aspects of FIWARE. Its main features include:
1313

14-
## Target Context Broker
14+
* **Proxying**: Forwards requests to a target Context Broker.
15+
* **Header Injection**: Can automatically inject headers such as `NGSILD-Tenant` and Wallet information
16+
(`Wallet-type`, `Wallet-Token`, `Wallet-address`) into proxied requests.
17+
* **Verification**: Optionally verifies tokens using Verifiable Credentials, integrating with a Credentials Config
18+
Service and Trusted Issuer Registry.
19+
* **Event Emission**: Emits events to a companion Tutorial Web App.
1520

16-
- `CONTEXT_BROKER` - location of the Context Broker
21+
To run the application in debug mode add `DEBUG=broker:*`.
1722

18-
## Additional Request Headers
23+
## Environment Variables
1924

20-
- `TENANT` - sets an NGSI-LD Tenant header
21-
- `WALLET_TYPE` - Sets a Wallet Type for Canis Major
22-
- `WALLET_TOKEN` - Sets a Wallet Token for Canis Major
23-
- `WALLET_ADDRESS` - Sets a Wallet Address for Canis Major
24-
- `ACCEPT_ENCODING` - sets an Accept-Encoding header
25+
### Core Configuration
2526

26-
## Verifiable Credentials Verifier
27+
- `PORT` - Port the application listens on. Default: `80`.
28+
- `DEBUG` - Debug level. Set to `broker:*` for full output.
2729

28-
- `VERIFY_CREDENTIALS` - set to `true` to enable verification
29-
- `CONFIG_SERVICE` - location of the Credentials Config Service
30-
- `WEB_APP_HOST` - location of the Tutorial App to display on screen
31-
- `WEB_APP_PORT` - port of the Tutorial App
30+
### Proxy Target
31+
32+
- `CONTEXT_BROKER` - URL of the target Context Broker. Default: `http://orion:1026`.
33+
34+
### Header Injection
35+
36+
These variables configure headers to be added to proxied requests:
37+
38+
- `TENANT` - Sets the `NGSILD-Tenant` header.
39+
- `WALLET_TYPE` - Sets the `Wallet-type` header (for Canis Major).
40+
- `WALLET_TOKEN` - Sets the `Wallet-Token` header (for Canis Major).
41+
- `WALLET_ADDRESS` - Sets the `Wallet-address` header (for Canis Major).
42+
- `ACCEPT_ENCODING` - Sets the `accept-encoding` header.
43+
44+
### Verifiable Credentials Verification
45+
46+
- `VERIFY_CREDENTIALS` - Set to `true` to enable credential verification. Default: `false`.
47+
- `CONFIG_SERVICE` - Host and port of the Credentials Config Service. Default: `localhost:8081`.
48+
- `TRUSTED_ISSUER_LIST` - URL of the Trusted Issuer List. If set, this overrides the list obtained from the Config
49+
Service.
50+
51+
### Event Emission
52+
53+
- `WEB_APP_HOST` - Hostname of the Tutorial Web App to emit events to. Default: `localhost`.
54+
- `WEB_APP_PORT` - Port of the Tutorial Web App. Default: `3000`.
55+
56+
### Healthcheck
57+
58+
- `HEALTHCHECK_PATH` - Path for the healthcheck endpoint. Default: `/health`.
59+
- `HEALTHCHECK_CODE` - HTTP Code expected for a healthy response. Default: `200`.
3260

3361
## How to build your own image
3462

@@ -70,3 +98,9 @@ COPY app /usr/src/app
7098
```
7199

72100
Full instructions can be found within the `Dockerfile` itself.
101+
102+
---
103+
104+
## License
105+
106+
[MIT](LICENSE) © 2020-2026 FIWARE Foundation e.V.

iot-devices/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,10 @@ This application provides sends information about devices on the farm.
2727
- PUT `/weather` - amend the weather - sunny/cloudy/raining
2828
- PUT `/temperature/:id` - amend the target temperature of a device
2929

30-
To run the application in debug mode add `DEBUG=devices:*`
30+
To run the application in debug mode add `DEBUG=devices:*`
31+
32+
---
33+
34+
## License
35+
36+
[MIT](LICENSE) © 2020-2026 FIWARE Foundation e.V.

0 commit comments

Comments
 (0)