# Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # BanyanDB connection (HTTP grpc-gateway, NOT :17912 gRPC) BANYANDB_TARGET=http://127.0.0.1:17913 # Prometheus/metrics monitoring target MONITOR_TARGET=http://127.0.0.1:2121 # Roles that may open the Monitor page (default admin) # CANOPY_MONITOR_ROLES=admin,readonly # Canopy BFF server port PORT=4000 # Optional public URL path prefix when Canopy is served behind a reverse proxy. # The proxy must preserve this prefix. Defaults to /. CANOPY_BASE_PATH=/ # REQUIRED: random secret (min 32 chars) # Generate: node -e "console.log(require('crypto').randomBytes(32).toString('hex'))" SESSION_SECRET= # Path to a JSON/YAML file listing Canopy users (alias for auth.local.users) # Format: [{"username":"admin","passwordHash":"","role":"admin"}] # Roles: admin (read-write) | readonly (viewer is accepted as readonly) # Legacy bcrypt hashes still verify with a startup warning. CANOPY_USERS=./users.yaml # Optional: auth config file with an `auth:` section (backend, local.users, session.*) # and overrides. backend `local` with no users boots and refuses every login. # CANOPY_AUTH_CONFIG= # CANOPY_AUTH_BACKEND=local # CANOPY_AUTH_SESSION_COOKIE_NAME=canopy_sid # CANOPY_AUTH_SESSION_TTL_MINUTES=60 # CANOPY_AUTH_SESSION_COOKIE_SECURE=auto # CANOPY_AUTH_TOKENS_FILE= # SSO client secret of the provider with id (see docs/auth-design.md); never put it in the config file. # CANOPY_AUTH_SSO__CLIENT_SECRET= # Optional: BanyanDB upstream service credential (attach-if-configured) # If set, this Basic-Auth credential is attached to EVERY proxied /api/* request. # Auth-disabled BanyanDB clusters ignore it harmlessly. BANYANDB_UPSTREAM_USERNAME= BANYANDB_UPSTREAM_PASSWORD= # Alternative: read password from a file (takes precedence over BANYANDB_UPSTREAM_PASSWORD) BANYANDB_UPSTREAM_PASSWORD_FILE= # Dev only: skip CANOPY_USERS requirement (seeds admin/admin). NEVER use in production. # Boot FAILS if CANOPY_DEV_NOAUTH=true and NODE_ENV=production. CANOPY_DEV_NOAUTH=false # Upstream request timeout in milliseconds (default: 120000 = 2 minutes) UPSTREAM_TIMEOUT_MS=120000