Skip to content

Commit 0a883fd

Browse files
authored
Merge pull request #1659 from input-output-hk/ensemble/rotate-documentation
Rotate current documentation
2 parents 8745b05 + 917ae8d commit 0a883fd

File tree

6 files changed

+157
-125
lines changed

6 files changed

+157
-125
lines changed

docs/website/versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-aggregator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,7 @@ Here is a list of the available parameters:
445445
| `signed_entity_types` | `--signed-entity-types` | - | `SIGNED_ENTITY_TYPES` | Signed entity types parameters (discriminants names in an ordered comma separated list) | - | `MithrilStakeDistribution,CardanoImmutableFilesFull,CardanoStakeDistribution` | - |
446446
| `snapshot_compression_algorithm` | `--snapshot-compression-algorithm` | - | `SNAPSHOT_COMPRESSION_ALGORITHM` | Compression algorithm of the snapshot archive | `zstandard` | `gzip` or `zstandard` | - |
447447
| `zstandard_parameters` | - | - | `ZSTANDARD_PARAMETERS__LEVEL` and `ZSTANDARD_PARAMETERS__NUMBER_OF_WORKERS` | Zstandard specific parameters | - | `{ level: 9, number_of_workers: 4 }` | - |
448+
| `allow_unparsable_block` | `--allow-unparsable-block` | - | `ALLOW_UNPARSABLE_BLOCK` | If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on (pre)production networks. | `false` | - | - |
448449

449450
`genesis bootstrap` command:
450451

docs/website/versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-client.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Run in release mode with a specific mode:
168168
Run in release mode with a custom configuration using environment variables:
169169

170170
```bash
171-
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) NETWORK=**YOUR_CARDANO_NETWORK** AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT** ./mithril-client
171+
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT** ./mithril-client
172172
```
173173

174174
:::tip
@@ -207,7 +207,6 @@ To prepare the environment variables, retrieve the values from the above **Mithr
207207

208208
```bash
209209
export MITHRIL_IMAGE_ID=**YOUR_MITHRIL_IMAGE_ID**
210-
export NETWORK=**YOUR_CARDANO_NETWORK**
211210
export AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
212211
export GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**)
213212
export SNAPSHOT_DIGEST=latest
@@ -217,7 +216,6 @@ Here is an example configuration for the `release-preprod` network and the `late
217216

218217
```bash
219218
export MITHRIL_IMAGE_ID=latest
220-
export NETWORK=preprod
221219
export AGGREGATOR_ENDPOINT=https://aggregator.release-preprod.api.mithril.network/aggregator
222220
export GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey)
223221
export SNAPSHOT_DIGEST=latest
@@ -227,7 +225,7 @@ Proceed by creating a shell function for the Mithril client:
227225

228226
```bash
229227
mithril_client () {
230-
docker run --rm -e NETWORK=$NETWORK -e GENESIS_VERIFICATION_KEY=$GENESIS_VERIFICATION_KEY -e AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT --name='mithril-client' -v $(pwd):/app/data -u $(id -u) ghcr.io/input-output-hk/mithril-client:$MITHRIL_IMAGE_ID $@
228+
docker run --rm -e GENESIS_VERIFICATION_KEY=$GENESIS_VERIFICATION_KEY -e AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT --name='mithril-client' -v $(pwd):/app/data -u $(id -u) ghcr.io/input-output-hk/mithril-client:$MITHRIL_IMAGE_ID $@
231229
}
232230
```
233231

@@ -336,7 +334,6 @@ Here is a list of the available parameters:
336334
| `verbose` | `--verbose` | `-v` | `VERBOSE` | Verbosity level | - | Parsed from the number of occurrences: `-v` for `Warning`, `-vv` for `Info`, `-vvv` for `Debug` and `-vvvv` for `Trace` | :heavy_check_mark: |
337335
| `unstable` | `--unstable` | - | - | Enable unstable commands | - | - | - |
338336
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Runtime mode | `dev` | - | :heavy_check_mark: |
339-
| `network` | - | - | `NETWORK` | Cardano network | - | `testnet` or `mainnet` or `devnet` | :heavy_check_mark: |
340337
| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | :heavy_check_mark: |
341338
| `genesis_verification_key` | - | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key | - | - | :heavy_check_mark: |
342339
| `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs | - | - | - |

docs/website/versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-signer.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,11 @@ Options:
162162
[env: METRICS_SERVER_PORT=]
163163
[default: 9090]
164164

165+
--allow-unparsable-block
166+
If set no error is returned in case of unparsable block and an error log is written instead.
167+
168+
Will be ignored on (pre)production networks.
169+
165170
-h, --help
166171
Print help (see a summary with '-h')
167172

@@ -246,3 +251,4 @@ Here is a list of the available parameters:
246251
| `enable_metrics_server` | `--enable-metrics-server` | - | `ENABLE_METRICS_SERVER` | Enable metrics HTTP server (Prometheus endpoint on /metrics) | `false` | - | - |
247252
| `metrics_server_ip` | `--metrics-server-ip` | - | `METRICS_SERVER_IP` | Metrics HTTP server IP | `0.0.0.0` | - | - |
248253
| `metrics_server_port` | `--metrics-server-port` | - | `METRICS_SERVER_PORT` | Metrics HTTP server listening port | `9090` | - | - |
254+
| `allow_unparsable_block` | `--allow-unparsable-block` | - | `ALLOW_UNPARSABLE_BLOCK` | If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on (pre)production networks. | `false` | - | - |

0 commit comments

Comments
 (0)