# Beckn-ONIX

Beckn-ONIX is [FIDE](https://fide.org/) project aimed at easing setup and maintainance of a [Beckn](https://becknprotocol.io/) Network using reference implementations. Objectives include setting up reliable, configurable and fast Beckn network as a virtual appliance. This initiative is independent of the evolution of the Beckn protocol. This effort is also aimed at inviting contributions from the community to create secure, reliable builds for production environments.

> Disclaimer : Beckn-onix is a reference implementation of the Beckn-onix stack. It is a reference application only and has not been tested for production environmens. However, implementers can fork this repository and build it for scale. The maintainer of this repository holds no liabillity for deployments of this application in production environments.

## GUI Installer

There is a community contributed browser based GUI installer to install multi-node reference implementation Beckn network. Refer to the [Installation Guide](./onix-gui/GUI/README.md) and [wizard guide](./onix-gui/README.md) for details.

Here is a [Demo Video](https://drive.google.com/file/d/1p1c1N9vCj-Rv0kBAsRIQ-KFfORTc1DjJ/view?usp=sharing) on how to use beckn-onix GUI:

[![Beckn Onix GUI](https://mishalabdullah.xyz/images/beckn-cli-youtube.png)](https://drive.google.com/file/d/1p1c1N9vCj-Rv0kBAsRIQ-KFfORTc1DjJ/view?usp=sharing)

## CLI Installer

For those comfortable with CLI, there is a command line installer to install multi-node reference implementation Beckn network. Refer to the [User Guide](./docs/user_guide.md) and [Setup Walkthrough](./docs/setup_walkthrough.md) for details.

Here is a [Demo Video](https://drive.google.com/file/d/1PfdhIpq-Qo6sDy0wAnO0zllCMGX718FW/view?usp=sharing) on how to use beckn-onix CLI:

[![Beckn Onix CLI](https://mishalabdullah.xyz/images/beckn-gui-youtube.png)](https://drive.google.com/file/d/1PfdhIpq-Qo6sDy0wAnO0zllCMGX718FW/view?usp=sharing)

## Other documents

- [Release Notes](./docs/release_notes.md)
- [Known Issues](./docs/known_issues.md)
- [Frequently asked questions (FAQ)](./docs/faq.md)
- **[Note on mandatory layer 2 configuration(Important)](./docs/notes/mandatory_layer_2_config.md).**
- **[Troubleshooting doc](https://github.com/beckn/missions/blob/main/docs/troubleshoot.md).**
- **[Log Interpretation](https://github.com/beckn/missions/blob/main/docs/log-interpretation.md).**

Experience the convenience and efficiency of Beckn-ONIX as you embark on your journey with Beckn protocols and open networks.
