setup-wizard.yml

version: "2"
fields:
  - title: Config mode
    id: config_mode
    description: >-
      You must choose a config method. Most users should choose
      "normal" mode, but more advanced users will be able to customize the
      installation of Besu and its environment variables.
    target:
      type: environment
      name: CONFIG_MODE
      service: besu
    enum:
      - "normal"
      - "advanced"
  - title: Storage Format
    id: storage_format
    description: >-
      Besu can use one of two storage formats, Forest of Tries or Bonsai Tries. 


      You can read about the differences [here](https://besu.hyperledger.org/en/stable/Concepts/Data-Storage-Formats). 


      Default storage format is BONSAI.
    target:
      type: environment
      name: STORAGE_FORMAT
      service: besu
    enum:
      - BONSAI
      - FOREST
    required: true
    if: { "config_mode": { "enum": ["advanced"] } }
  - title: Sync Mode
    id: sync_mode
    description: >-
      Besu can use one of three sync modes, FULL (slow, archive node), FAST (fast, full node), X_SNAP (faster, experimental and works with BONSAI), and X_CHECKPOINT (Fastest, and latest sync method works with BONSAI). 


      You can read about the differences [here](https://besu.hyperledger.org/en/stable/Reference/CLI/CLI-Syntax/#sync-mode). 


      Default sync mode is FAST.
    target:
      type: environment
      name: SYNC_MODE
      service: besu
    enum:
      - FAST
      - FULL
      - X_SNAP
      - X_CHECKPOINT
    required: true
    if: { "config_mode": { "enum": ["advanced"] } }
  - title: Enable WebSocket API
    id: enable_ws
    description: >-
      You can enable or disable the WebSocket API here, if needed.
    target:
      type: environment
      name: WS_ENABLED
      service: besu
    enum:
      - "true"
      - "false"
    required: true
  - title: Max HTTP RPC connections
    id: max_rpc_connections_http
    description: >-
      To prevent flooding of the node, there is a sensible max connections limit. You can alter this variable here.
    target:
      type: environment
      name: MAX_HTTP_CONNECTIONS
      service: besu
    if: { "config_mode": { "enum": ["advanced"] } }