Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leighmcculloch committed Oct 12, 2023
1 parent 3a9e647 commit c10667f
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,18 @@ To enable the Soroban RPC server provide the following command line flags when s

The Soroban RPC Server will be avaialble on port 8000 of the container, and the base URL path for Soroban RPC will be `http://<container_host>:8000/soroban/rpc`. This endpoint uses [JSON-RPC](https://www.jsonrpc.org/specification) protocol. Refer to example usages in [soroban-example-dapp](https://github.com/stellar/soroban-example-dapp).

To enable Soroban diagnostic events provide the following command line flag when starting the container:
`--enable-soroban-diagnostic-events`

In local network mode diagnostics are enabled by default and can be disabled with:
`--disable-soroban-diagnostic-events`

To enable soroban rpc admin endpoint for access to metrics and [Go pprof (profiling)](https://pkg.go.dev/net/http/pprof), include the `--enable-soroban-rpc-admin-endpoint` flag, the HTTP endpoint will be listening on container port 6061, which can be exposed with standard docker port rule `-p "6061:6061"`, the published endpoints are:
```
http://<container_host>:6061/metrics
http://<container_host>:6061/debug/pprof/
```


### Deploy to Digital Ocean

You can deploy the quickstart image to DigitalOcean by clicking the button below. It will by default create a container that can be used for development and testing, running the `latest` tag, in ephemeral mode, and on the `local` network.
Expand Down

0 comments on commit c10667f

Please sign in to comment.