charm: juju-gui
service: juju-gui
settings:
  builtin-server-logging:
    default: true
    description: |
      Set the GUI server log level. Possible values are debug, info, warning
      and error. The log file is placed in /var/log/upstart/guiserver.log.
    type: string
    value: info
  cached-fonts:
    default: true
    description: |
      Configure the GUI to use locally cached fonts, rather than the Google CDN
      as supplied by the Google fonts API.  The CDN is faster in almost every
      circumstance except local (LXC) environments, and so it is the default;
      but if a browser is running the GUI on a closed network, using cached
      fonts will let the GUI load much faster and render properly.
    type: boolean
    value: false
  charmstore-url:
    default: true
    description: |
      The URL of the charm store API service. This option supersedes the
      charmworld-url option above.
    type: string
    value: https://api.jujucharms.com/charmstore/
  charmworld-url:
    default: true
    description: |
      The URL of the charm catalog site ("charmworld") from which charm
      catalog data will be drawn.
    type: string
    value: https://manage.jujucharms.com/
  command-log-file:
    default: true
    description: |
      The log file where stdout and stderr should be sent for all commands
      that are run by charm hooks.
    type: string
    value: /var/log/juju/juju-gui.log
  ga-key:
    default: true
    description: |
      The Google Analytics key to use.  Set to blank to disable analytics.
      The team developing the Juju GUI benefits from understanding how
      different deployments use the tool.  By keeping the default key value,
      anonymized usage data is reported back using Google Analytics.  The type
      of data collected includes the charms that are deployed and the number
      of units per service.  Use of analytics is optional but we hope you will
      allow us to improve our tool based on your experience.
    type: string
    value: UA-41463568-2
  hide-login-button:
    default: true
    description: |
      There are deployment modes for Juju GUI which are not intended as regular
      use mode. In these cases, login/logout are disabled and instead there is
      a link to jujucharms.com.
    type: boolean
    value: false
  juju-core-version:
    default: true
    description: |
      The version of Juju tools used for the charm deployment. If left empty,
      the Juju version is dynamically retrieved.
    type: string
  juju-gui-console-enabled:
    default: true
    description: |
      Whether or not the console should be enabled for the browser.
    type: boolean
    value: false
  juju-gui-debug:
    default: true
    description: |
      Run Juju GUI in debug mode, serving the uncompressed GUI source files.
    type: boolean
    value: false
  juju-gui-source:
    default: true
    description: |
      Where to install Juju GUI from. Possible values the following.
      - 'local' (default): The latest local release will be deployed. Releases
        are stored in the releases directory of this charm.
      - 'stable': The latest release from the "stable" series will be deployed.
      - 'develop': The latest, in development, version from the Git repository.
      - a specific release version (e.g '0.1.0' or '0.1.0+build.1'): The
        specified stable version will be deployed. A suitable release is
        looked up in the local releases repository (see the "local" choice
        above). If not found locally, the release will be downloaded from
        Launchpad.
      - a Git branch (e.g. 'https://github.com/juju/juju-gui.git' or
        'https://github.com/mitechie/juju-gui.git updated-test-runner'): A
        release will be created and deployed from the specified Git
        repository. You can include a branch name or a specific commit SHA
        after the url to the Git repository to deploy that specific commit
        point. You may instead specify a commit SHA: (e.g.
        'https://github.com/mitechie/juju-gui.git @de5e61bf9fa') which will
        clone the git repository and then check out the specified commit
        before building the release.
      - a URL: The release found at the given URL (ex: http://...) will be
        deployed.
    type: string
    value: local
  login-help:
    default: true
    description: |
      The help text shown to the user on the login screen. If not provided, a
      default message is used, suggesting how to find the login credentials.
    type: string
  nagios_context:
    default: true
    description: |
      Used by the nrpe-external-master subordinate charm.
      A string that will be prepended to instance name to set the host name
      in nagios. So for instance the hostname would be something like:
          juju-myservice-0
      If you are running multiple environments with the same services in them
      this allows you to differentiate between them.
    type: string
    value: juju
  password:
    description: |
      If given, the password to use for the environment to immediately
      connect.  Do not set unless you understand and accept the risks.
    type: string
    value: bdx
  port:
    default: true
    description: |
      Supply a different port to host the GUI on besides the default 80 and
      443. If the provided port is not a valid TCP port (ranging from 1 to
      65535) the defaults are used.
    type: int
  read-only:
    default: true
    description: |
      Whether or not the GUI is in read-only mode. Note that read-only mode is
      advisory, and enforced only in the client. If someone can access the
      websocket and has the password, they can send commands over the
      websocket to mutate the environment.
    type: boolean
    value: false
  repository-location:
    default: true
    description: |
      The charm depends on several software packages that are not packaged in
      Ubuntu.  In order to ensure that only versions known to work with our
      charm are used, there is a single PPA where all packages are kept.  The
      juju-gui-charmers team supports 'stable' and 'devel' versions.  Only
      stable should be used for production.  For enterprise deployments that
      do not allow access to resources outside of their control, the location
      can be any specification as long as it is recognizable by
      'add-apt-repository'.
    type: string
    value: ppa:juju-gui-charmers/stable
  sandbox:
    default: true
    description: |
      Run using an in-memory sandbox rather than a real Juju backend. Sandbox
      is a client side construct running entirely in the client. Sandbox does
      not currently support imported environment simulation.
    type: boolean
    value: false
  secure:
    default: true
    description: |
      Set to false to serve the GUI over an insecure HTTP connection.
      Do not set unless you understand and accept the risks.
    type: boolean
    value: true
  serve-tests:
    default: true
    description: |
      Whether or not the GUI unit tests are exposed. If this option is
      enabled, unit tests can be run in the browser by visiting the URL
      "https://[Juju GUI address]/test/".
    type: boolean
    value: false
  ssl-cert-contents:
    default: true
    description: |
      The contents of the certificate file to be used in SSL connections to
      the GUI. Both ssl-cert-contents and ssl-key-contents must be provided.
      If not, cetificates will be automatically generated.
    type: string
  ssl-cert-path:
    default: true
    description: |
      The path to the directory where the SSL certificates are stored.
    type: string
    value: /etc/ssl/juju-gui
  ssl-key-contents:
    default: true
    description: |
      The contents of the private key file to be used in SSL connections to
      the GUI. Both ssl-cert-contents and ssl-key-contents must be provided.
      If not, cetificates will be automatically generated.
    type: string
  ws-secure:
    default: true
    description: |
      Force the client to use secure ("wss") or unsecure ("ws") WebSockets.
      If left unset, secure WebSockets are used based on the secure option: if
      secure is True the "wss" protocol is used, othewise the "ws" one is used.
    type: boolean