Skip to Content
Commands Referencepelican-serverpelican-server configpelican-server config describe

pelican-server config describe

Print documentation for the specified config parameter

Synopsis

The ‘describe’ command prints detailed documentation for a specified configuration parameter, including its type, default value, description, related components, and whether it is deprecated or hidden.

pelican-server config describe [parameter] [flags]

Examples

# View documentation for the Server.WebPort parameter
pelican config describe server.webPort

Options

  -h, --help   help for describe

Options inherited from parent commands

      --config string       config file (default is $HOME/.config/pelican/pelican.yaml)
  -d, --debug               Enable debug log messages
  -f, --federation string   Pelican federation to utilize
      --json                output results in JSON format
  -L, --log string          Specified log output file
  -s, --service string      Load config as if running the given service. Valid values: cache, origin, director, registry. Mutually exclusive with --config.
      --version             Print the version and exit
      --with-discovery      Enable federation discovery to resolve Federation.DirectorUrl, Federation.RegistryUrl, etc. Without this flag, no network calls are made.

SEE ALSO

pelican server configpelican-server config dump