README
¶
Filecoin Retrieval Pro
Filecoin Secondary Retrieval Market Provider
Start the service
Create a config file
Create a .env file, using .env.example as a reference:
cp .env.example .env
Start the service with Docker
Start the project with Docker:
make start
The server should be available at http://localhost:9030
Development
Start the service with Docker
Start the service:
make dev
The server should be available at http://localhost:9030
To rebuild containers, following option can be used:
make dev arg=--build
Start the service manually
Start the project manually:
make start-dev
Config
Config variables description:
| name | description | options | default |
|---|---|---|---|
| LOG_LEVEL | logging level | INFO | |
| LOG_TARGET | logging target | STDOUT / FILE | STDOUT |
| LOG_DIR | logging directory | ||
| LOG_FILE | logging file | ||
| LOG_MAX_BACKUPS | logging max backups | ||
| LOG_MAX_AGE | logging max age | ||
| LOG_MAX_SIZE | logging max size | ||
| LOG_COMPRESS | logging compress | true / false | |
| SERVICE_HOST | service host | provider | |
| SERVICE_PORT | service port | 9030 | |
| SERVICE_SCHEME | service scheme | http |
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
provider
Package main - program entry point for a Retrieval Provider node.
|
Package main - program entry point for a Retrieval Provider node. |
|
Package config - combines operations used to setup parameters for Retrieval Provider node in FileCoin network
|
Package config - combines operations used to setup parameters for Retrieval Provider node in FileCoin network |
|
internal
|
|
|
api/adminapi
Package adminapi - set of remote API used to call a Retrieval Provider, grouped to a specific caller type - Retrieval Admin.
|
Package adminapi - set of remote API used to call a Retrieval Provider, grouped to a specific caller type - Retrieval Admin. |
|
api/clientapi
Package clientapi - set of remote API used to call a Retrieval Provider, grouped to a specific caller type - Retrieval Client.
|
Package clientapi - set of remote API used to call a Retrieval Provider, grouped to a specific caller type - Retrieval Client. |
|
api/gatewayapi
Package gatewayapi - set of remote API used to call a Retrieval Provider, grouped to a specific caller type - Retrieval Gateway.
|
Package gatewayapi - set of remote API used to call a Retrieval Provider, grouped to a specific caller type - Retrieval Gateway. |
|
api/providerapi
Package providerapi - set of remote API used to call a Retrieval Provider, grouped to a specific caller type - Retrieval Provider.
|
Package providerapi - set of remote API used to call a Retrieval Provider, grouped to a specific caller type - Retrieval Provider. |
|
core
Package core - structure which represents a Provider's current state, including setting, configuration, references to all running Provider APIs of this instance.
|
Package core - structure which represents a Provider's current state, including setting, configuration, references to all running Provider APIs of this instance. |
|
util
Package util - contains a collection of different functions used across all Retrieval Provider instances.
|
Package util - contains a collection of different functions used across all Retrieval Provider instances. |
|
util/settings
Package settings - holds configuration specific to a Retrieval Provider node.
|
Package settings - holds configuration specific to a Retrieval Provider node. |
|
scripts
|
|
Click to show internal directories.
Click to hide internal directories.