You should have REMME node binaries on your machine, you can setup release or development environment by following the instructions on github repo
In the root directory of REMME project there is hidden .env file by editing that you can configure your node.
- REMME_REST_API_PORT - The port the REST API server will listen to. By default the value is set to 8080
- REMME REST API REMME_REST_API_AVAILABLE_METHODS - List of methods which should be enabled on. By default the value is set to *
- Should follow such format: "endpoint1:method1,method2;endpoint2:*" Example: "/personal:GET,POST;/certificate:POST;/certificate/p12:*"
- Single * means that all methods are enabled for all endpoints
- If no value specified there will be no REST API methods enable
- REMME_CONTAINER_EXPORTS_FOLDER -Path of the host folder where container exported data will be stored. Example case: .p12 certificates will be saved on main machine if using /cerrtificate/p12 REST API methods.
- By default the value is set to ./default_export in the root directory of REMME project
- If empty or no value specified endpoints will not export data on the host machine
After you have up and running configured REMME node you can access Swagger UI to learn methods documentation and try out some operations by accessing http://localhost:8080/api/v1/ui.
- Current version of REST API is not suitable for public usage. It can be used to build clients or execute internal commands on a local machine.
- There is no mechanism for event subscribing yet. It will be implemented in future releases.
- In current version node works in dev-mode, so all the transactions will be immediately processed and stored on the local blockchain.