Skip to content

Files

Latest commit

 

History

History
31 lines (21 loc) · 1.68 KB

getting-started.md

File metadata and controls

31 lines (21 loc) · 1.68 KB

Getting Started

Environment Variables

Octant is configurable through environment variables defined at runtime.

  • KUBECONFIG - set to non-empty location if you want to set KUBECONFIG with an environment variable.
  • OCTANT_DISABLE_OPEN_BROWSER - set to a non-empty value if you don't the browser launched when the dashboard start up.
  • OCTANT_LISTENER_ADDR - set to address you want dashboard service to start on. (e.g. localhost:8080)
  • OCTANT_VERBOSE_CACHE - set to a non-empty value to view cache actions
  • OCTANT_LOCAL_CONTENT - set to a directory and dash will serve content responses from here. An example directory lives in examples/content
  • OCTANT_PLUGIN_PATH - add a plugin directory or multiple directories separated by :. Plugins will load by default from $HOME/.config/octant/plugins

Note: If using fish shell, tilde expansion may not occur when using env to set environment variables.

Setting Up a Development Environment

These build tools can be installed via Makefile with make go-install.

A development binary can be built by make octant-dev.

For UI changes, see the README located in web/.

If Docker and Drone are installed, tests and build steps can run in a containerized environment.