{"id":13506023,"url":"https://github.com/FIWARE/context.Orion-LD","last_synced_at":"2025-03-30T03:30:40.641Z","repository":{"id":37470276,"uuid":"147631897","full_name":"FIWARE/context.Orion-LD","owner":"FIWARE","description":"Context Broker and CEF building block for context data management which supports both the NGSI-LD and the NGSI-v2 APIs","archived":false,"fork":true,"pushed_at":"2024-04-14T21:58:30.000Z","size":48775,"stargazers_count":49,"open_issues_count":161,"forks_count":37,"subscribers_count":13,"default_branch":"develop","last_synced_at":"2024-04-15T06:41:40.802Z","etag":null,"topics":["contextual-data","fiware","fiware-orion","json-ld","ngsi-ld"],"latest_commit_sha":null,"homepage":"https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.06.01_60/gs_CIM009v010601p.pdf","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"telefonicaid/fiware-orion","license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FIWARE.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES_NEXT_RELEASE","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-09-06T07:05:05.000Z","updated_at":"2024-03-14T01:06:15.000Z","dependencies_parsed_at":"2023-02-19T06:45:49.372Z","dependency_job_id":"568bbc34-6d4e-4393-bdcd-19ff21258b8c","html_url":"https://github.com/FIWARE/context.Orion-LD","commit_stats":null,"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Fcontext.Orion-LD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Fcontext.Orion-LD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Fcontext.Orion-LD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Fcontext.Orion-LD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FIWARE","download_url":"https://codeload.github.com/FIWARE/context.Orion-LD/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246273533,"owners_count":20750904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["contextual-data","fiware","fiware-orion","json-ld","ngsi-ld"],"created_at":"2024-08-01T01:00:33.089Z","updated_at":"2025-03-30T03:30:35.631Z","avatar_url":"https://github.com/FIWARE.png","language":"C++","funding_links":[],"categories":["FIWARE Catalogue","Interoperability and Digital Infrastructure"],"sub_categories":["Core Context Management"],"readme":"# Orion Context Broker (with Linked Data Extensions)\n\n[![FIWARE Core Context Management](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/core.svg)](https://www.fiware.org/developers/catalogue/)\n[![License badge](https://img.shields.io/github/license/FIWARE/context.Orion-LD.svg)](https://opensource.org/licenses/AGPL-3.0)\n[![Docker badge](https://img.shields.io/badge/quay.io-fiware%2Forion--ld-grey?logo=red%20hat\u0026labelColor=EE0000)](https://quay.io/repository/fiware/orion-ld)\n[![Support badge](https://img.shields.io/badge/support-sof-yellowgreen.svg)](http://stackoverflow.com/questions/tagged/fiware-orion)\n[![NGSI-LD badge](https://img.shields.io/badge/NGSI-LD-red.svg)](https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.08.01_60/gs_cim009v010801p.pdf)\n\u003cbr\u003e\n[![Documentation badge](https://readthedocs.org/projects/fiware-orion/badge/?version=latest)](http://fiware-orion.readthedocs.io/en/latest/?badge=latest)\n![Status](https://nexus.lab.fiware.org/static/badges/statuses/incubating.svg)\n[![Coverage Status](https://coveralls.io/repos/github/FIWARE/context.Orion-LD/badge.svg?branch=develop)](https://coveralls.io/github/FIWARE/context.Orion-LD?branch=develop)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4800/badge)](https://bestpractices.coreinfrastructure.org/projects/4800)\n\nThis project is part of [FIWARE](https://www.fiware.org/). For more information check the FIWARE Catalogue entry for\n[FIWARE Core Context Management](https://github.com/Fiware/catalogue/tree/master/core).\n\nIssues on this projects can be reported as [github issues](https://github.com/FIWARE/context.Orion-LD/issues),\nwhile questions are preferred on [Stack Overflow](http://stackoverflow.com/questions/tagged/fiware-orion), using the tag `fiware-orion`.\n\n\u003e The latest release of Orion-LD is [1.6.0](https://github.com/FIWARE/context.Orion-LD/releases/tag/1.6.0) from July 2024\n\nOrion-LD is a Context Broker and [CEF](https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/About+us)\n[building block](https://joinup.ec.europa.eu/collection/egovernment/solution/cef-context-broker) for context data\nmanagement, implementting both the [NGSI-LD API](https://en.wikipedia.org/wiki/NGSI-LD) and the\n[NGSIv2 API](https://fiware.github.io/specifications/OpenAPI/ngsiv2). It is currently a fork of the original\n[Orion Context Broker](https://github.com/telefonicaid/fiware-orion) extending support to add **NGSI-LD** and linked\ndata concepts. Orion-LD follows the [ETSI](https://en.wikipedia.org/wiki/ETSI) specification for **NGSI-LD** and has\nbeen tested to be a stable and fast **NGSI-LD** broker with near compliance to the version 1.6.1 of the NGSI-LD API\nspecification (and some features from newer releases).\n\n\n## License\nOrion-LD is licensed under [Affero General Public License (GPL) version 3](./LICENSE).\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eFurther information on the use of the AGPL open source license\u003c/strong\u003e\u003c/summary\u003e\n  \n### Are there any legal issues with AGPL 3.0? Is it safe for me to use?\nThere is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL\n(or AGPL) licenses are mostly related with the fact that different people assign different\ninterpretations on the meaning of the term “derivate work” used in these licenses. Due to this,\nsome people believe that there is a risk in just _using_ software under GPL or AGPL licenses\n(even without _modifying_ it).\n\nFor the avoidance of doubt, the owners of this software licensed under an AGPL-3.0 license\nwish to make a clarifying public statement as follows:\n\n\u003e Please note that software derived as a result of modifying the source code of the\n\u003e software in order to fix a bug or incorporate enhancements IS considered a derivative\n\u003e work of the product. Software that merely uses or aggregates (i.e. links to) an\n\u003e otherwise unmodified version of existing software IS NOT considered a derivative work.\n\n\u003c/details\u003e\n\n## Contribution to Orion-LD\nAnyone wishing to contribute to Orion-LD, be it fixing/adding documentation, tests, source code, all types of contributions are welcome.\nFor source code contributions, please see the [Contribution guidelines](doc/manuals/contribution_guidelines.md).\n\n\n## General Information on NGSI-LD\n**NGSI-LD** is an an extended subset of [JSON-LD](https://en.wikipedia.org/wiki/JSON-LD) for use with context management systems.\nIts payloads are encoded as [linked data](https://en.wikipedia.org/wiki/Linked_data) using JSON.\n\nThe NGSI-LD Specification is regularly updated and published by ETSI.\nThe latest specification is [version 1.8.1](https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.08.01_60/gs_cim009v010801p.pdf), published in March 2024.\nThe next release, version 1.9.1, is expected for September/October 2024·\n\nA few presentations on NGSI-LD:\n* [NGSI-LD Overview](https://docs.google.com/presentation/d/1tgh6gBdcZHRPU_ehM7M5rGCI83CrYimCwJXxzRI5GDg)\n* [NGSI-LD in 30 min](https://docs.google.com/presentation/d/1z1IzikB7NxIkihDosV4KrtNS_IJUdrNiwC_b4wAI0rc)\n* [NGSI-LD in a Nutshell](https://docs.google.com/presentation/d/14aoHGYzmfn_a31ByG_Tf8pejuP6oWhjqhraLsPtRp_k)\n\nExamples of **NGSI-LD** payloads can be found in [ETSI](https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/tree/master/examples).\nSee also the [OpenAPI Specification of NGSI-LD](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/cim/ngsi-ld-openapi/-/raw/1.7.1/ngsi-ld-api.yaml).  \nThat is for version 1.7.1 of the NGSI-LD API specification.  \nWe're currently working on updating this to v1.8.1, ETA: Dec 2024.\n\nIf you are not sharing your data across systems and have no need for linked data concepts, then the current stable\nversion of **NGSI** (**NGSI-v2**) is more than sufficient.\nIf so, please use the original [Orion](https://github.com/telefonicaid/fiware-orion) instead of Orion-LD (note that Orion-LD is **not** up-to-date with Orion in terms of NGSI v2).\n\n\n| :books: [Documentation](https://github.com/FIWARE/context.Orion-LD/tree/develop/doc/manuals-ld) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/core/orion-ld) | \u003cimg style=\"height:1em\" src=\"https://quay.io/static/img/quay_favicon.png\"/\u003e [quay.io](https://quay.io/repository/fiware/orion-ld) |\n| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n\n## NGSI-LD Context Broker Feature Comparison\nAn Excel file detailing the current compatibility of the development version of the Orion-LD Context Broker against the features (up to v1.8.1) of the API specification can be downloaded [here](https://docs.google.com/spreadsheets/d/18tq0_PZFl5WCfYUElcdI6M3Vlin4hP-M).\n\n\n## Test and Deployment of Orion-LD\nIf you want to start testing Orion-LD, the most common option is to use Docker.\nThere are a number of docker images to choose from.\n\nIf you (at your own risk) want to evaluate the bleeding edge development changes, you can use the latest image:\n`docker run fiware/orion-ld:latest` or better: use\n[docker compose](https://github.com/FIWARE/context.Orion-LD/blob/develop/docker/docker-compose.yml) to run it.\n\nThe use of the \"latest\" tag is NOT RECOMMENDED, as it keeps changing. Please don't use it. It's solely meant for internal testing.\nThe recommendation is to use the newest fixed tag you find and stick to it until you have need for some newer feature/fix and then change to that newer fixed tag.\nEvery merged pull request results in a new fixed tag in dockerhub/quay.io.\n\nPlease note that for production and/or performance implementations, there is a thorough guide for that right [here](https://github.com/FIWARE/load-tests)\n\nIf you want to use a more stable image, the latest release (as of July 2024) is\n[1.6.0](https://github.com/FIWARE/context.Orion-LD/releases/tag/1.6.0)\n\n```console\ndocker run quay.io/fiware/orion-ld:1.7.0\n```\n\nPlease check [quay.io](https://quay.io/repository/fiware/orion-ld?tab=tags) or [dockerhub](https://hub.docker.com/r/fiware/orion-ld/tags) for other releases.\n\n## Documentation:\n-   [Guide to NGSI-LD entities and attributes](doc/manuals-ld/entities-and-attributes.md)\n-   [Guide to the JSON-LD @context](doc/manuals-ld/the-context.md)\n-   [Installation Guide](doc/manuals-ld/installation-guide.md)\n-   [Quick Start Guide](doc/manuals-ld/quick-start-guide.md)\n-   [External Libraries](doc/manuals-ld/external-libraries.md)\n-   [Temporal Representation](doc/manuals-ld/troe.md)\n-   [The Broker as Context Server](doc/manuals-ld/contextServer.md)\n-   [Roadmap](doc/roadmap.md)\n\nA Test Suite for NGSI-LD compliant brokers can be found [here](https://github.com/fiware/NGSI-LD_Tests).\nThis test suite is deprecated in favor of the newer [ETSI NGSI-LD API Conformance Test Suite](https://forge.etsi.org/rep/cim/ngsi-ld-test-suite).\n(Orion-LD passes about 95% of the test cases of this older deprecated test suite.)\n\nAbout the ETSI funded conformance test suite, a third TTF (Testing Task force) is currently in progress, to improve on overall coverage and to\naggregate conformance tests for distributed operations.\nThis third TTF is expected to finish in February 2025 and by then, the ETSI NGSI-LD conformance test suite should be fully operational,\nand thus test results for Orion-LD can and will be published.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFIWARE%2Fcontext.Orion-LD","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFIWARE%2Fcontext.Orion-LD","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFIWARE%2Fcontext.Orion-LD/lists"}