The Ocelloids integrated node.
2.0K
Docker image for running the Ocelloids Service Node in integrated mode.
The published images support both amd64 and arm64 platforms.
The work directory is set to /opt/oc.
The server configuration uses the environment variables described in the table below.
| Variable | Description | Default |
|---|---|---|
| OC_ADDRESS | The address to bind to. | localhost |
| OC_PORT | The TCP port number to listen on. | 3000 |
| OC_CONFIG_FILE | The service configuration file. | - |
| OC_DATA_DIR | The data directory. | ./.db |
| OC_LEVEL_ENGINE | The LevelDB engine. | classic |
| OC_DB_SCHEDULER_ENABLE | Enables or disables the task scheduler. | true |
| OC_DB_SCHEDULER_FREQUENCY | Milliseconds to wait before each tick. | 5000 |
| OC_DB_JANITOR_SWEEP_EXPIRY | Milliseconds before a task is swept. | 1500000 |
| OC_CLOSE_GRACE_DELAY | Milliseconds for the graceful close to finish. | 5000 |
| OC_JWT_SIG_KEY_FILE | Ed25519 private key used to sign and verify the authorization tokens. | - |
| OC_JWT_ISSUER | Issuer identifier. | localhost |
| OC_JWT_ALLOWED_ISSUERS | Allowed issuers. | localhost |
| OC_MAX_BLOCK_DIST | Maximum distance in blocks for the catch-up. | 50 |
| OC_TELEMETRY_ENABLE | Enables or disables the telemetry service. | true |
| OC_WS_MAX_CLIENTS | Maximum number of websocket clients. | 10000 |
| OC_CORS | Enables or disables CORS support. | false |
| OC_CORS_CREDENTIALS | Access-Control-Allow-Credentials CORS header. | true |
| OC_CORS_ORIGIN | Access-Control-Allow-Origin CORS header. Use "true" for any origin. | /https?://localhost.*/ |
| OC_RATE_LIMIT_MAX | Max number of requests per limit window. | 60 |
| OC_RATE_LIMIT_WINDOW | Rate limit window in milliseconds. | 60000 |
| OC_SUBSCRIPTION_MAX_PERSISTENT | Maximum number of persistent subscriptions. | 5000 |
| OC_SUBSCRIPTION_MAX_EPHEMERAL | Maximum number of ephemeral subscriptions. | 5000 |
| OC_DISTRIBUTED | Enables distributed mode for the exeuctor. | false |
| OC_REDIS_URL | Redis connection URL.[^1] | redis://localhost:6379 |
Run the image mounting the configuration as volumes:
Note:
Use -v <PATH_TO_CHAIN_SPECS_DIR>:/opt/oc/chain-specs:ro if you need to resolve chain specs for light client configurations.
docker run -d \
-p 3000:3000 \
-e OC_CONFIG_FILE=./config/<YOUR_CONFIG>.toml \
-e OC_JWT_SIG_KEY_FILE=<PATH_TO_YOUR_PRIVATE_KEY_FILE> \
-e OC_JWT_ISSUER=<ISSUER_ID> \
-e OC_JWT_ALLOWED_ISSUERS=<ISSUER_ID> \
-v <YOUR_PATH_TO_CONFIG_DIR>:/opt/oc/config:ro \
sodazone/ocelloids-integrated-node
Please replace PATH_TO_YOUR_PRIVATE_KEY_FILE with the path to a PEM or JWK-encoded Ed25519 private key used to sign and verify the authorization tokens, ISSUER_ID with the identifier of the issuer (e.g., 'api.mydomain.io'), and YOUR_PATH_TO_CONFIG_DIR with the path to the directory containing the configuration TOML file.
Content type
Image
Digest
sha256:4640af4f1…
Size
132.7 MB
Last updated
5 months ago
docker pull sodazone/ocelloids-integrated-node