|
1 | | -# iexec-result-proxy |
2 | | -iExec Result Proxy (IPFS, ...) |
| 1 | +# iExec Result Proxy |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +The iExec Result Proxy stores results of iExec tasks on IPFS. |
| 6 | + |
| 7 | +The iExec Result Proxy is available as an OCI image on [Docker Hub](https://hub.docker.com/r/iexechub/iexec-result-proxy/tags). |
| 8 | + |
| 9 | +To run properly, the iExec Result Proxy requires: |
| 10 | +* A blockchain node. iExec smart contracts must be deployed on the blockchain network. |
| 11 | +* A MongoDB instance to persist its data. |
| 12 | +* An IPFS node where iExec tasks results will be pushed and retrieved. |
| 13 | + |
| 14 | +## Configuration |
| 15 | + |
| 16 | +You can configure the iExec Result Proxy with the following properties: |
| 17 | + |
| 18 | +| Environment variable | Description | Type | Default value | |
| 19 | +| --- | --- | --- | --- | |
| 20 | +| IEXEC_RESULT_PROXY_PORT | Server HTTP port of the result proxy. | Positive integer | `13200` | |
| 21 | +| MONGO_HOST | Mongo server host. Cannot be set with URI. | String | `localhost` | |
| 22 | +| MONGO_PORT | Mongo server port. Cannot be set with URI. | Positive integer | `13202` | |
| 23 | +| IEXEC_CHAIN_ID | Chain ID of the blockchain network to connect. | Integer | `17` | |
| 24 | +| IEXEC_IS_SIDECHAIN | Define if iExec on-chain protocol is built on top of token (`false`) or native currency (`true`). | Boolean | `false` | |
| 25 | +| IEXEC_PRIVATE_CHAIN_ADDRESS | Private URL to connect to the blockchain node. | URL | `http://localhost:8545` | |
| 26 | +| IEXEC_PUBLIC_CHAIN_ADDRESS | [unused] Public URL to connect to the blockchain node. | URL | `http://localhost:8545` | |
| 27 | +| IEXEC_HUB_ADDRESS | Proxy contract address to interact with the iExec on-chain protocol. | Ethereum address | `0xBF6B2B07e47326B7c8bfCb4A5460bef9f0Fd2002` | |
| 28 | +| IEXEC_START_BLOCK_NUMBER | [Unused] | Positive integer | `0` | |
| 29 | +| IEXEC_GAS_PRICE_MULTIPLIER | Transactions will be sent with `networkGasPrice * IEXEC_GAS_PRICE_MULTIPLIER`. | Float | `1.0` | |
| 30 | +| IEXEC_GAS_PRICE_CAP | In Wei, will be used for transactions if `networkGasPrice * IEXEC_GAS_PRICE_MULTIPLIER > gasPriceCap`. | Integer | `22000000000` | |
| 31 | +| IEXEC_IPFS_HOST | Host to connect to the IPFS node. | String | `127.0.0.1` | |
| 32 | +| IEXEC_IPFS_PORT | Server port of the IPFS node. | Positive integer | `5001` | |
0 commit comments