Rotate current documentation

By running 'make update-current'
input-output-hk · Apr 29, 2024 · 917ae8d · 917ae8d
1 parent dd881df
commit 917ae8d
Show file tree

Hide file tree

Showing 6 changed files with 157 additions and 125 deletions.
diff --git a/...ioned_docs/version-maintained/manual/developer-docs/nodes/mithril-aggregator.md b/...ioned_docs/version-maintained/manual/developer-docs/nodes/mithril-aggregator.md
@@ -445,6 +445,7 @@ Here is a list of the available parameters:
 | `signed_entity_types` | `--signed-entity-types` | - | `SIGNED_ENTITY_TYPES` | Signed entity types parameters (discriminants names in an ordered comma separated list) | - | `MithrilStakeDistribution,CardanoImmutableFilesFull,CardanoStakeDistribution` | - |
 | `snapshot_compression_algorithm` | `--snapshot-compression-algorithm` | - | `SNAPSHOT_COMPRESSION_ALGORITHM` | Compression algorithm of the snapshot archive | `zstandard` | `gzip` or `zstandard` | - |
 | `zstandard_parameters` | - | - | `ZSTANDARD_PARAMETERS__LEVEL` and `ZSTANDARD_PARAMETERS__NUMBER_OF_WORKERS` | Zstandard specific parameters | - | `{ level: 9, number_of_workers: 4 }` | - |
+| `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` | - | - |
 
 `genesis bootstrap` command:
 

diff --git a/...versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-client.md b/...versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-client.md
@@ -168,7 +168,7 @@ Run in release mode with a specific mode:
 Run in release mode with a custom configuration using environment variables:
 
 ```bash
-GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) NETWORK=**YOUR_CARDANO_NETWORK** AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT** ./mithril-client
+GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT** ./mithril-client
 ```
 
 :::tip
@@ -207,7 +207,6 @@ To prepare the environment variables, retrieve the values from the above **Mithr
 
 ```bash
 export MITHRIL_IMAGE_ID=**YOUR_MITHRIL_IMAGE_ID**
-export NETWORK=**YOUR_CARDANO_NETWORK**
 export AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
 export GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**)
 export SNAPSHOT_DIGEST=latest
@@ -217,7 +216,6 @@ Here is an example configuration for the `release-preprod` network and the `late
 
 ```bash
 export MITHRIL_IMAGE_ID=latest
-export NETWORK=preprod
 export AGGREGATOR_ENDPOINT=https://aggregator.release-preprod.api.mithril.network/aggregator
 export GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey)
 export SNAPSHOT_DIGEST=latest
@@ -227,7 +225,7 @@ Proceed by creating a shell function for the Mithril client:
 
 ```bash
 mithril_client () {
-  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 $@
+  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 $@
 }
 ```
 
@@ -336,7 +334,6 @@ Here is a list of the available parameters:
 | `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: |
 | `unstable` | `--unstable` | - | - | Enable unstable commands | - | - | - |
 | `run_mode` | `--run-mode` | - | `RUN_MODE` | Runtime mode | `dev` | - | :heavy_check_mark: |
-| `network` | - | - | `NETWORK` | Cardano network | - | `testnet` or `mainnet` or `devnet` | :heavy_check_mark: |
 | `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | :heavy_check_mark: |
 | `genesis_verification_key` | - | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key | - | - | :heavy_check_mark: |
 | `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs | - | - | - |

diff --git a/...versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-signer.md b/...versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-signer.md
@@ -162,6 +162,11 @@ Options:
           [env: METRICS_SERVER_PORT=]
           [default: 9090]
 
+      --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.
+
   -h, --help
           Print help (see a summary with '-h')
 
@@ -246,3 +251,4 @@ Here is a list of the available parameters:
 | `enable_metrics_server` | `--enable-metrics-server` | - | `ENABLE_METRICS_SERVER` | Enable metrics HTTP server (Prometheus endpoint on /metrics) | `false` | - | - |
 | `metrics_server_ip` | `--metrics-server-ip` | - | `METRICS_SERVER_IP` | Metrics HTTP server IP | `0.0.0.0` | - | - |
 | `metrics_server_port` | `--metrics-server-port` | - | `METRICS_SERVER_PORT` | Metrics HTTP server listening port | `9090` | - | - |
+| `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` | - | - |