The API Proxy component, also known as reverse proxy, is designed to operate as an entry point to multiple DID Methods, in order to simplify their management and resolution. This is because each DID implementation has its own specifications and dynamics.
The application uses the following technologies:
- NodeJs
- TypeScript
Clone the repository
- Open the project with the selected editor
- Open a terminal and run:
- cd source
- yarn
- yarn build
- yarn start- Have an empty Linux server.
- Install the component and its images, which can be found on Dockerhub.
To install a component from Docker Hub on your server, follow these steps:
-
Connect to the server.
-
Install Docker on the server: If you don't have Docker installed on your server yet, follow the instructions to install Docker on your operating system. You can find detailed guides in the official Docker documentation.
-
Download the component image from Docker Hub using the 'docker pull' command
You must specify the full name of the image, which includes the username or organization name on Docker Hub and the image name. Run the container:
docker pull quarkid/api-proxyOnce the component image has been downloaded to your server, you can run a container using the 'docker run' command.
- Verify that the container is running: Use the docker ps command to verify that the container is running on your server.
These need to be configured in the file /api-proxy/source/src/.env
N/A
N/A
The application must have internet connectivity to communicate with the network and the api-zkSync component.
The application must have internet connectivity.