Mokhtar Naamani f4cb727dec bump types and metadata npm package version | преди 2 години | |
---|---|---|
.. | ||
bin | преди 3 години | |
config | преди 3 години | |
docs | преди 2 години | |
scripts | преди 2 години | |
src | преди 2 години | |
.eslintignore | преди 3 години | |
.eslintrc.js | преди 3 години | |
.gitignore | преди 3 години | |
.prettierignore | преди 3 години | |
README.md | преди 3 години | |
config.yml | преди 2 години | |
docker-compose.yml | преди 3 години | |
openapitools.json | преди 3 години | |
package.json | преди 2 години | |
tsconfig.json | преди 3 години |
The Joystream Distributor CLI package contains a set of commands that allow:
To see the list of all available commands and their flags / arguments, check out the commands documentation.
All the configuration values required by Joystream Distributor CLI are provided via a single configuration file (either yml
or json
).
The path to the configuration will be (ordered from highest to lowest priority):
--configPath
flag provided when running a command, orCONFIG_PATH
environment variable, orconfig.yml
in the current working directory by defaultAll configuration values can be overriden using environment variables, which may be useful when running the distributor node as docker service.
To determine environment variable name based on a config key, for example intervals.cacheCleanup
, use the following formula:
pascalCase
fieldnames to SCREAMING_SNAKE_CASE
: intervals.cacheCleanup
=> INTERVALS.CACHE_CLEANUP
__
: INTERVALS.CACHE_CLEANUP
=> INTERVALS__CACHE_CLEANUP
JOYSTREAM_DISTRIBUTOR__
prefix: INTERVALS__CACHE_CLEANUP
=> JOYSTREAM_DISTRIBUTOR__INTERVALS__CACHE_CLEANUP
In case of arrays or oneOf
objects (ie. keys
), the values must be provided as json string, for example JOYSTREAM_DISTRIBUTOR__KEYS="[{\"suri\":\"//Bob\"}]"
.
In order to unset a value you can use one of the following strings as env variable value: "off"
"null"
, "undefined"
, for example: JOYSTREAM_DISTRIBUTOR__LOGS__FILE="off"
.
For more envirnoment variable examples see the distributor-node
service configuration in docker-compose.yml.
For detailed configuration reference, checkout the config schema documentation.
To understand how the distributor node works in detail, checkout the node documentation.