eric/onix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #69 from beckn/onix-gui-readme

Browse Source 
Onix gui readme
This commit is contained in:
Venkatesh Babu
2024-05-06 08:32:58 +05:30
committed by GitHub
parent 1eda1a3c2c 6cebf1de23
commit cb5c989e49
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -2,17 +2,18 @@
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. 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.
Within the install folder you will find a `beckn-onix.sh` file which is an installer that helps create a multi-node Beckn network using reference implementations ## GUI Installer
Refer to the following documents for more information: 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.
## CLI Installer
For those familiar 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.
## Additional documents
- [User Guide](./docs/user_guide.md)
- [Step by step walkthrough of a setup](./docs/setup_walkthrough.md)
- [Frequently asked questions (FAQ)](./docs/faq.md) - [Frequently asked questions (FAQ)](./docs/faq.md)
- [release notes](./install/RELEASE.md) - **Note on mandatory Layer 2 Config (Important)**
- [GUI Installation Guide](./onix-gui/GUI/README.md) Please refer to this [note on mandatory layer 2 configuration](./docs/notes/mandatory_layer_2_config.md).
Experience the convenience and efficiency of Beckn-ONIX as you embark on your journey with Beckn protocols and open networks. Experience the convenience and efficiency of Beckn-ONIX as you embark on your journey with Beckn protocols and open networks.
**Note on mandatory Layer 2 Config (Important)**
Please refer to this [note on mandatory layer 2 configuration](./docs/notes/mandatory_layer_2_config.md).