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

Added reverse proxy configuration diagram

Browse Source
This commit is contained in:
Venkatesh Babu
2024-07-02 08:56:55 +05:30
parent 70148123be
commit ec7dcd50dc
4 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/user_guide.md
View File

@@ -40,6 +40,10 @@ The following diagram shows a conceptual view of a multi-node Beckn network. The
![Typical deployment](./images/sample_deployment.png)
The following diagram shows the reverse proxy configuration (referred to also in the individual installations below) using the URLs used in the examples. Refer to this diagram during the reverse proxy configuration steps.
![Reverse Proxy Configuration](./images/reverse_proxy_configuration.png)
**Use of docker and reference implementations**
Docker compose and docker are extensively used in the installation and running of the various component software. Similarly the Beckn-ONIX installer, itself being a reference implementation, installs the reference implentation of the Beckn Adapter for the BAP and BPP, reference implementation of the registry and gateway. In order to interact with the internals of these components, we will need to enter the container. Familiarity with Docker will be useful in working with the installation. To list the running containers use `docker ps`. Similarly for example to connect to a container and browse it using shell, use `docker exec -it bap-client sh`
@@ -244,6 +248,7 @@ Refer to the [core specification](https://github.com/beckn/protocol-specificatio
- In order for people new to Beckn who want to try out Beckn on their own machine, choose the option to "Set up a network on your local machine" in the main screen. The all in one installation has preconfigured values for variables and so pretty much does not ask for any input.
## Upgrading to a new version
- The following commands illustrate upgrade of the docker image for Protocol Server (here BPP). Use similar process for other components
```
@@ -288,4 +293,4 @@ In the role of reverse proxy, Nginx will forward communication that came on a pa
[This document](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) explains the configuration of reverse proxy using proxy_pass
You can find sample Nginx configuration for the Registry, Gateway, BAP and BPP [here](./sample_nginx_configurations.md)
You can find sample Nginx configuration for the Registry, Gateway, BAP and BPP [here](./notes/sample_nginx_configurations.md)