Skip to content
This repository has been archived by the owner on Jul 25, 2024. It is now read-only.

Latest commit

 

History

History
22 lines (20 loc) · 3.94 KB

ENVIRONMENT.md

File metadata and controls

22 lines (20 loc) · 3.94 KB

Environment Variables

This application recognizes the following environment variables:

Name Description Range/Type Required? Default
API_PORT HTTP port that the application listens on 1025 - 65535 3000
CAPACITY_LIMIT Maximum amount of provider capacity this app is allowed to use (per epoch) type: 'percentage' 'amount' value: number (may be percentage, ie '80', or absolute amount of capacity) JSON (example) Y
FREQUENCY_URL Blockchain node address http(s): or ws(s): URL Y
PROVIDER_ACCOUNT_SEED_PHRASE Seed phrase for provider MSA control key string Y
PROVIDER_ID Provider MSA ID integer Y
REDIS_URL Connection URL for Redis URL Y
ASSET_EXPIRATION_INTERVAL_SECONDS Number of seconds to keep completed asset entrie in the cache before expiring them > 0 Y
ASSET_UPLOAD_VERIFICATION_DELAY_SECONDS Base delay in seconds used for exponential backoff while waiting for uploaded assets to be verified available before publishing a content notice >= 0 Y
BATCH_INTERVAL_SECONDS Number of seconds between content publishing batches. This is so that the service waits a reasonable amount of time for additional content to publishing before submitting a batch--it represents a trade-off between maximum batch fullness and minimal wait time for published content > 0 Y
BATCH_MAX_COUNT Maximum number of items that can be submitted in a single batch > 0 Y
CHAIN_ENVIRONMENT Environment for mapping announcement type to schema ID (use 'dev' for e2e tests) dev|rococo|testnet|mainnet Y
FILE_UPLOAD_MAX_SIZE_IN_BYTES Max file size (in bytes) allowed for asset upload > 0 Y
IPFS_BASIC_AUTH_SECRET If using Infura, put auth token here, or leave blank for Kubo RPC string N blank
IPFS_BASIC_AUTH_USER If using Infura, put Project ID here, or leave blank for Kubo RPC string N blank
IPFS_ENDPOINT URL to IPFS endpoint URL Y
IPFS_GATEWAY_URL IPFS gateway URL. '[CID]' is a token that will be replaced with an actual content ID URL template Y