Add known issue on Gateway restarts

README.md

@@ -2,7 +2,7 @@
 
 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. 
+> 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
 
@@ -12,7 +12,6 @@ Here is a [Demo Video](https://drive.google.com/file/d/1p1c1N9vCj-Rv0kBAsRIQ-KFf
 
 [![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.
@@ -21,11 +20,10 @@ Here is a [Demo Video](https://drive.google.com/file/d/1PfdhIpq-Qo6sDy0wAnO0zllC
 
 [![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).**
 

docs/known_issues.md

@@ -0,0 +1,21 @@
+# Known issues
+
+## Gateway is not working after restart
+
+**First Reported:**
+2024-07-19
+
+**Problem:**
+Gateway keeps on restarting on bootup. It happened after the machine was restarted. The gateway has not been updated and still it is crashing.
+
+**Root Cause:**
+The version of Gateway that was installed prior to July 18 2024, had hard coded a short list of standard registries. This included a registry which has been decomissioned in August. The result of this is that the gateway tries to contact this decomissioned registry during bootup and since it cannot find it, crashes and restarts. This happens with older gateways even without updating the software. If the old gateway software was restarted due to whatever reason, this issue starts to show up.
+
+**Solution:**
+Update the gateway software with the new image (built after July 18 2024). This has removed the hard code of the decomissioned registry and everything should work ok. The following is one way of updating the gateway software. Perform these on the machine that has the gateway container within the beckn-onix/install folder after updating the beckn-onix git clone.
+
+```
+$ docker-compose -f docker-compose-gateway.yml down
+$ docker rmi fidedocker/gateway
+$ docker-compose -f docker-compose-gateway.yml up --detach
+```