Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Give proper command to show help #1184

Merged
merged 1 commit into from
May 24, 2024

Conversation

bbrandt
Copy link
Contributor

@bbrandt bbrandt commented May 23, 2024

After running through the instructions all the way through make all, there does not seem to be a ./bin/api produced from the build. ./pyrra api --help was able to give me these instructions:

Usage: pyrra api [flags]

Runs Pyrra's API and UI.

Flags:
  -h, --help                                    Show context-sensitive help.
      --log-level="info"                        Used to set the logging level of the application. Valid options are 'debug', 'info',
                                                'warn' or 'error'
      --log-format="logfmt"                     Used to set the logging format. Valid options are 'logfmt' or 'json'

      --prometheus-url=http://localhost:9090    The URL to the Prometheus to query.
      --prometheus-external-url=PROMETHEUS-EXTERNAL-URL
                                                The URL for the UI to redirect users to when opening Prometheus. If empty the same as
                                                prometheus.url
      --api-url=http://localhost:9444           The URL to the API service like a Kubernetes Operator.
      --route-prefix=""                         The route prefix Pyrra uses. If run behind a proxy you can change it to something like
                                                /pyrra here.
      --ui-route-prefix=""                      The route prefix Pyrra's UI uses. This is helpful for when the prefix is stripped by a
                                                proxy but still runs on /pyrra. Defaults to --route-prefix
      --prometheus-bearer-token-path=""         Bearer token path
      --prometheus-basic-auth-username=""       The HTTP basic authentication username
      --prometheus-basic-auth-password=""       The HTTP basic authentication password
      --tls-cert-file=""                        File containing the default x509 Certificate for HTTPS.
      --tls-private-key-file=""                 File containing the default x509 private key matching --tls-cert-file.
      --tls-client-ca-file=""                   File containing the CA certificate for the client

Copy link
Member

@metalmatze metalmatze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh. You're totally right!
That binary may have existed in the very early days, but it hasn't for years. Thanks for sending the fix!

@metalmatze metalmatze merged commit 19fed78 into pyrra-dev:main May 24, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants