Environment Variables #
These environment variables configure VTAdmin, most commonly when creating a
vtadmin-web production build as described in the VTAdmin Operator's Guide. These environment variables also enumerated in web/vtadmin/src/react-app-env.d.ts.
Under the hood,
vtadmin-web uses create-react-app, which requires all environment variables to be prefixed with
REACT_APP to avoid accidentally including secrets in the static build. For more on custom environment variables with create-react-app, see "Adding Custom Environment Variables".
These environment variables can be passed inline to the
npm run build command or added to a .env file.
|Required||string||-||The full address of vtadmin-api's HTTP(S) interface. Example: "https://vtadmin.example.com:12345"|
|Optional||string||-||An API key for https://bugsnag.com. If defined, the @bugsnag/js client will be initialized. Your Bugsnag API key can be found in your Bugsnag Project Settings.|
|Optional||string||-||The branch vtadmin-web was built with. Used only for debugging; will appear on the (secret) /settings route in the UI.|
|Optional||string||-||The SHA vtadmin-web was built with. Used only for debugging; will appear on the (secret) /settings route in the UI.|
|Optional||string||"VTAdmin"||Used for the document.title property. Overriding this can be useful to differentiate between multiple VTAdmin deployments, e.g., "VTAdmin (staging)".|
|Optional||string||-||Optional, but recommended. When |
|Optional||string||-||Configures the |
|Optional||string||"false"||If "true", UI controls that correspond to write actions (PUT, POST, DELETE) will be hidden. Note that this only affects the UI. If write actions are a concern, Vitess operators are encouraged to also configure vtadmin-api for role-based access control (RBAC) if needed.|