setup-wizard.yml

version: "2"
fields:
  - title: Gnosis RPC Endpoint
    id: swap-endpoint
    description: >-
      Gnosis blockchain endpoint used for on-chain activities. Specify a custom Gnosis RPC endpoint, or install one of the following packages:

      - Nethermind xDai [Install link](http://my.dappnode/#/installer/nethermind-xdai.dnp.dappnode.eth)
    target:
      type: environment
      name: BEE_BLOCKCHAIN_RPC_ENDPOINT
      service: bee
    required: true
  - title: ENS resolver RPC (Ethereum mainnet)
    id: resolver-options
    description: >-
      Ethereum blockchain endpoint used for resolving ENS names. Specify a custom RPC endpoint, or install one of the following packages:

      - Geth [Install link](http://my.dappnode/#/installer/geth.dnp.dappnode.eth)

      - Erigon [Install link](http://my.dappnode/#/installer/erigon.dnp.dappnode.eth)

      - Nethermind [Install link](http://my.dappnode/#/installer/nethermind.public.dappnode.eth)
    target:
      type: environment
      name: BEE_RESOLVER_OPTIONS
      service: bee
    required: false
  - title: Welcome message
    id: welcome-message
    description: A welcome message string sent during handshakes
    target:
      type: environment
      name: BEE_WELCOME_MESSAGE
      service: bee
  - title: Bee API address
    id: api-addr
    description: Bee API URL
    target:
      type: environment
      name: BEE_API_ADDR
      service: bee
  - title: Full Node Mode
    id: full-node
    description: Enable the full node mode, if you remove this field, you will run the node in light mode, you can obtain more info about it in bee documentation https://docs.ethswarm.org/docs/access-the-swarm/light-nodes
    target:
      type: environment
      name: BEE_FULL_NODE
      service: bee
    enum:
      - "true"
      - "false"
    required: true
  - title: Enable SWAP Incentives
    id: enable-swap
    description: SWAP bandwidth incentives allow for compensating bandwidth for serving data.
    target:
      type: environment
      name: BEE_SWAP_ENABLE
      service: bee
    enum:
      - "true"
      - "false"
    required: true
  - title: Set target neighborhood
    id: target-neighborhood
    description: >-
      Define a target neighbourhood in which to mine an overlay address. This is a complex undertaking, and it's recommended that you read the bee documentation https://docs.ethswarm.org/docs/bee/installation/install#set-target-neighborhood-optional
    target:
      type: environment
      name: BEE_TARGET_NEIGHBORHOOD
      service: bee
  - title: Log messages verbosity level
    id: log-verbosity
    description: >-
      Set logging verbosity level
    target:
      type: environment
      name: BEE_VERBOSITY
      service: bee
    enum:
      - "silent"
      - "error"
      - "warn"
      - "info"
      - "debug"
      - "trace"
  - title: Reserve Capacity Doubling
    id: reserve-capacity-doubling
    description: >-
      Set Reserve Capacity Doubling
    target:
      type: environment
      name: BEE_RESERVE_CAPACITY_DOUBLING
      service: bee
    enum:
      - "0"
      - "1"
    required: true
  - title: Perform database action
    id: db-action
    description: >-
      **DANGER**: Some actions such as **nuke**, **compact** and **repair-reserve** are destructive actions. If the process is stopped for any reason, the localstore may become corrupted. It is recommended that you [backup](http://my.dappnode/packages/my/swarm.public.dappnode.eth/backup) first.

      - **none**: Do nothing. Start the bee node by default.

      - **nuke**: Enabling this will nuke your localstore database. Bee will resync all data next time it boots up.

      - **compact**: Compacts the localstore sharky store. Compaction is a destructive process. If the process is stopped for any reason, the localstore may become corrupted.

      - **repair-reserve**: Repairs the reserve by resetting the binIDs and removes dangling entries. This is a destructive process. If the process is stopped for any reason, the reserve may become corrupted.

      - **info**: Prints the different indexes present in the Database.

      - **validate**: Validates the localstore sharky store.

      - **validate-pin**: Validates pin collection chunks with sharky store.

    target:
      type: environment
      name: BEE_DB_ACTION
      service: bee
    enum:
      - "none"
      - "nuke"
      - "compact"
      - "repair-reserve"
      - "info"
      - "validate"
      - "validate-pin"
  - title: Storage data mountpoint
    id: swarmDataMountpoint
    target:
      type: allNamedVolumesMountpoint
    description: >-
      Use this option if you want to store the Storage data in a separate drive. Make sure to have sufficient free space