ibexus/ibexus-connector repository overview

⁠IBEXUS Connector

Welcome to IBEXUS! This IBEXUS Connector is used access the IBEXUS platform. It provides the following features:

• Process creation and execution create business processes and run them on IBEXUS
• Data sharing and verification share data in an asserted way between parties. Verify shared data in a transparent process between multiple participants
• Permanent data storage create permanent data records from your asserted data which can be accessed forever
• Accounts and users create your IBEXUS account and users for collaborating on the IBEXUS platform
• Signing and encryption all the necessary cryptography is manages by the IBEXUS Connector. You do not need to implement anything manually
• Integration with secret managers so far, AWS Secrets Manager and local file storage are implemented. Please reach out if you need to be able to connect other secret managers
• AWS integration with Lambda run IBEXUS connector as a Lambda function behind AWS API Gateway with AWS Secrets Manager integration
• Integrated sandbox for testing and development, use the integrated sandbox environment to simulate all interactions locally

Go to https://ibexus.io⁠ for more information about the IBEXUS platform. Go to https://github.com/ibexus-platform/ibexus-connector⁠ for the latest version of this software. Contact [email protected]⁠ with any questions you might have.

⁠How to connect to the IBEXUS platform

You can use IBEXUS Connector in one of three ways:

• Command line tool use IBEXUS Connector as a command line utility for testing and development. Secrets are stored on your filesystem, do not use for production.
• REST API run the IBEXUS Connector as a docker container image in your environment and use it to connect to the IBEXUS platform.

⁠Download and installation

Follow these instructions to download and install IBEXUS connector in your environment. Releases are available in two kinds: an executable file or a container image. Both kinds support command line tool and REST API usage of IBEXUS Connector.

⁠Container image

Access the image at Docker Hub: https://hub.docker.com/r/ibexus/ibexus-connector⁠.

⁠Environment variables

• IBEXUS_API_KEYS can be set to a list of comma-separated keys that should allow access to the API. The API is not secured if this variable is not set.
• IBEXUS_SECRETS_STORAGE should be set to the secrets storage type that is being used. Default is a non-secure file-based storage. Set the environment variable to aws-secrets-manager to enable AWS Secrets Manager support. It will work out of the box on AWS if the AWS config environment variables are set for the container.
• IBEXUS_PORT can be used to set a non-default port. The default port is 8000.

⁠REST API documentation

Refer to the interactive documentation in order to find out more about all possible REST requests by navigating to /docs at the address of the container. Per default the exposed port is 8000.

⁠Command line tool usage

Connect to your container via a shell to use ibexus-connector on the command line. The executable is located at /usr/local/bin/ibexus-connector.

⁠Executable file

Download the executable binary at https://github.com/ibexus-platform/ibexus-connector/releases⁠. At the moment Linux 64bit is supported. Unpack the .zip file and move the contained executable to a location of your choice, preferrably /usr/local/bin or some other location in your shell's PATH. Run the binary from your terminal with ibexus-connector. The binary supports both the command line tool and the REST API modes of IBEXUS Connector. The executable has extensive documentation available. Get started by executing ibexus-connector --help in your terminal.

⁠Documentation

Get started quickly with our guides. You will learn how to create a simple business process and run it on the IBEXUS sandbox.

Getting started with the IBEXUS Connector command line tool⁠

Getting started with the IBEXUS Connector REST API⁠

Getting started with the IBEXUS Connector Lambda function⁠