Skip to content
Snippets Groups Projects
Commit a56c6c82 authored by Denis Sukhoroslov's avatar Denis Sukhoroslov
Browse files

Merge branch 'feature/docs-improve' into 'main'

TCR docs improvements

See merge request !93
parents 181b1ba8 ae14b8f1
No related branches found
No related tags found
1 merge request!93TCR docs improvements
Pipeline #40640 passed
# Trusted Content Resolver
## Description
XFSC Trusted Content Resolver Service allows Trusted Framework Pointers resolution and validation.
TRAIN provides a trust management infrastructure for Gaia-X Federation Services (GXFS). Trusted Content Resolver service allows Trusted Framework Pointers resolution and verification. The Trust Services API (TSA) component can use the Trusted Content Resolver libraries to verify the institutional trust of verifiable credentials. The Organizational Credential Manager (OCM) service can use the Trusted Content Resolver libraries to validate the trust of the organizational verifiable credentials before storing them in the wallet. The Notary service (via the Notarization API) uses the TSPA Connector to enroll trusted entities into the trust framework and add them via the TSPA/Federator to the Trust List.
This is a Reference Implementation of the [Gaia-X TRAIN Lot](https://eclipse.dev/xfsc/train/train/#trusted-content-resolver).
So here is the reference implementation of the [Gaia-X TRAIN Lot](https://eclipse.dev/xfsc/train/train/#trusted-content-resolver).
## Documentation
All service documentation, installation instructions and other materials can be found in the [TCR documentation section](./docs).
## [Click here to view the TCR Documentation](./docs)
All service documentation including installation instructions, operation and usage guides and other materials can be found by the link above.
## Support
To get support you can open an issue in the project [Issues](https://gitlab.eclipse.org/eclipse/xfsc/train/trusted-content-resolver/-/issues) section.
......@@ -16,10 +16,10 @@ To get support you can open an issue in the project [Issues](https://gitlab.ecli
To start with TCR project please follow the instructions: [Steps to build TCR](./docker/README.md).
## Roadmap
The project v1.0.0 will be released in Decembery 2023.
TCR version 1.0.0 was released in December 2023. The current release version is 1.0.5. All TCR releases can be found the standard GitLab [Releases](https://gitlab.eclipse.org/eclipse/xfsc/train/trusted-content-resolver/-/releases) section.
## Contributing
If you want to contribute to the project - please request a membership at [Project Members](https://gitlab.eclipse.org/eclipse/xfsc/train/trusted-content-resolver/-/project_members) section or drop an email to project maintainer [Denis Sukhoroslov](mailto:dsukhoroslov@gmail.com).
If you want to contribute to the project - please request a membership at [Project Members](https://gitlab.eclipse.org/eclipse/xfsc/train/trusted-content-resolver/-/project_members) section or drop an email to project maintainer [Lauresha Memeti](https://gitlab.eclipse.org/laureshamemeti).
## Authors and acknowledgment
The project is implemented by T-Systems International GmbH, project members are:
......
......@@ -8,3 +8,11 @@ This documentation serves as a comprehensive guide for Trusted Content Resolver
- [Build Procedures](./build_proc)
- [Installation & Configuration](./install)
- [Client API](./client_api)
- [Client installation & integration guide](./usage_guide)
- [Usage Guide](https://gitlab.eclipse.org/eclipse/xfsc/xfsc-spec-2/-/blob/main/docs/traincd/traincd.md?ref_type=heads#trusted-content-resolving)
- [Security Concept](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/concepts/security)
- [GDPR design decisions](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/concepts/gdpr)
- [Blueprint](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation/-/tree/main/delivery)
- [FAQ](https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation)
- [Glossary](https://gitlab.eclipse.org/eclipse/xfsc/xfsc-spec-2/-/blob/main/docs/train/train.md?ref_type=heads#definitions-acronyms-and-abbreviations)
## Usage guide for installation of libraries with GO, Javascript, Java and Python
TCR provides client libraries to allow seamless integration with TCR REST API from various programming languages. Client REST API is generated as part of TCR CICD procedure, and can be downloaded from the following locations:
- GO: generated sources are published at [clients/go module](../../clients/go), to import it see [cmd/main.go app](../../clients/go/cmd/main.go)
- Java: generated sources are not stored in the repository, but can be downloaded as artifacts from GitLab CICD pipeline: [https://gitlab.eclipse.org/api/v4/projects/5223/jobs/artifacts/main/download?job=maven:test](https://gitlab.eclipse.org/api/v4/projects/5223/jobs/artifacts/main/download?job=maven:test). After downloading and unziping the artifacts archive java client library can be accessed as `./clients/java/target/trusted-content-resolver-java-client-1.1.0-SNAPSHOT.jar`. It can be installed in local maven repository and then can be used in the client project build procedure. For more details see [this discussion](https://gitlab.eclipse.org/eclipse/xfsc/train/trusted-content-resolver/-/issues/62#note_1800083).
- JavaScript: generated sources are not stored in the repository, but can be downloaded as artifacts from GitLab CICD pipeline as above. After downloading and unziping the archive JS client artifacts can be accessed as `./clients/js` folder.
- Python: generated sources are not stored in the repository, but can be downloaded as artifacts from GitLab CICD pipeline as above. After downloading and unziping the archive JS client artifacts can be accessed as `./clients/py` folder.
## Usage guide to integrate with Notarization Service (NOT)
Integration with NOT is detailed in the [TRAIN Concept Document](https://gitlab.eclipse.org/eclipse/xfsc/xfsc-spec-2/-/blob/main/docs/traincd/traincd.md?ref_type=heads#integration-with-notary) and out of scope of TCR functionality.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment