Skip to content

Latest commit

 

History

History
126 lines (81 loc) · 3.54 KB

README.md

File metadata and controls

126 lines (81 loc) · 3.54 KB
Raw

veilid-node-docker

CI/CD

Run a Veilid Node in docker

image

Install and run a Veilid Node standalone

official: https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md

Install and run on docker

/bin/bash build.sh
/bin/bash test.sh
/bin/bash run.sh
/bin/bash veilid-server

Arguments

veilid-server 0.3.3

Veilid Server

Usage: veilid-server [OPTIONS]

Options:
  -d, --daemon
          Run in daemon mode in the background

  -f, --foreground
          Run in the foreground

  -c, --config-file <FILE>
          Specify a configuration file to use
          
          [default: /root/.config/veilid/veilid-server.conf]

  -s, --set-config <CONFIG>
          Specify configuration value to set (key in dot format, value in json format), eg: logging.api.enabled=true

  -p, --password <PASSWORD>
          Specify password to use to protect the device encryption key

      --new-password <PASSWORD>
          Change password used to protect the device encryption key. Device storage will be migrated

      --no-attach
          Do not automatically attach the server to the Veilid network
          
          Default behaviour is to automatically attach the server to the Veilid network, this option disables this behaviour.

      --debug
          Turn on debug logging on the terminal

      --trace
          Turn on trace logging on the terminal

      --otlp <endpoint>
          Turn on OpenTelemetry tracing
          
          This option uses the GRPC OpenTelemetry protocol, not HTTP. The format for the endpoint is host:port, like 'localhost:4317'

      --subnode-index <SUBNODE_INDEX>
          Run as an extra daemon on the same machine for testing purposes, specify a number greater than zero to offset the listening ports

      --generate-key-pair <crypto_kind>
          Only generate a new keypair and print it
          
          Generate a new keypair for a specific crypto kind and print both the key and its secret to the terminal, then exit immediately.

      --set-node-id <key_set>
          Set the node ids and secret keys
          
          Specify node ids in typed key set format ('\[VLD0:xxxx,VLD1:xxxx\]') on the command line, a prompt appears to enter the secret key set interactively.

      --delete-protected-store
          Delete the entire contents of the protected store (DANGER, NO UNDO!)

      --delete-table-store
          Delete the entire contents of the table store (DANGER, NO UNDO!)

      --delete-block-store
          Delete the entire contents of the block store (DANGER, NO UNDO!)

      --dump-config
          Instead of running the server, print the configuration it would use to the console

      --dump-txt-record
          Prints the bootstrap TXT record for this node and then quits

      --emit-schema <schema_name>
          Emits a JSON-Schema for a named type

      --bootstrap <BOOTSTRAP_LIST>
          Specify a list of bootstrap hostnames to use

      --panic
          panic on ctrl-c instead of graceful shutdown

      --network-key <KEY>
          password override to use for network isolation

      --console
          enable tokio console

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version